Resource: NetworkEndpointGroup
Represents a collection of network endpoints.
A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview.
JSON representation |
---|
{ "kind": string, "id": string, "creationTimestamp": string, "selfLink": string, "name": string, "description": string, "networkEndpointType": enum, "size": integer, "loadBalancer": { "zone": string, "network": string, "subnetwork": string, "defaultPort": integer }, "region": string, "zone": string, "network": string, "subnetwork": string, "defaultPort": integer, "annotations": { string: string, ... }, "cloudRun": { "service": string, "tag": string, "urlMask": string }, "appEngine": { "service": string, "version": string, "urlMask": string }, "cloudFunction": { "function": string, "urlMask": string }, "serverlessDeployment": { "platform": string, "resource": string, "version": string, "urlMask": string }, "pscTargetService": string, "pscData": { "consumerPscAddress": string, "pscConnectionId": string, "pscConnectionStatus": enum, "producerPort": integer } } |
Fields | |
---|---|
kind |
[Output Only] Type of the resource. Always |
id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
selfLink |
[Output Only] Server-defined URL for the resource. |
name |
Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression |
description |
An optional description of this resource. Provide this property when you create the resource. |
networkEndpointType |
Type of network endpoints in this network endpoint group. Can be one of |
size |
[Output only] Number of network endpoints in the network endpoint group. |
loadBalancer |
This field is only valid when the network endpoint group is used for load balancing. [Deprecated] This field is deprecated. |
loadBalancer |
[Output Only] The URL of the zone where the network endpoint group is located. [Deprecated] This field is deprecated. |
loadBalancer |
The URL of the network to which all network endpoints in the NEG belong. Uses |
loadBalancer |
Optional URL of the subnetwork to which all network endpoints in the NEG belong. [Deprecated] This field is deprecated. |
loadBalancer |
The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either |
region |
[Output Only] The URL of the region where the network endpoint group is located. |
zone |
[Output Only] The URL of the zone where the network endpoint group is located. |
network |
The URL of the network to which all network endpoints in the NEG belong. Uses |
subnetwork |
Optional URL of the subnetwork to which all network endpoints in the NEG belong. |
defaultPort |
The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either |
annotations |
Metadata defined as annotations on the network endpoint group. |
cloudRun |
Only valid when |
cloudRun.service |
Cloud Run service is the main resource of Cloud Run. The Example value: "run-service". |
cloudRun.tag |
Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The Example value: "revision-0010". |
cloudRun.urlMask |
An URL mask is one of the main components of the Cloud Function. A template to parse For example, request URLs |
appEngine |
Only valid when |
appEngine.service |
Optional serving service. The Example value: |
appEngine.version |
Optional serving version. The Example value: |
appEngine.urlMask |
An URL mask is one of the main components of the Cloud Function. A template to parse For example, the request URLs |
cloudFunction |
Only valid when |
cloudFunction.function |
A user-defined name of the Cloud Function. The Example value: |
cloudFunction.urlMask |
An URL mask is one of the main components of the Cloud Function. A template to parse For example, request URLs |
serverlessDeployment |
Only valid when |
serverlessDeployment.platform |
The platform of the backend target(s) of this NEG. The only supported value is API Gateway: |
serverlessDeployment.resource |
The user-defined name of the workload/instance. This value must be provided explicitly or in the
|
serverlessDeployment.version |
The optional resource version. The version identified by this value is platform-specific and is follows:
|
serverlessDeployment.urlMask |
An URL mask is one of the main components of the Cloud Function. A template to parse platform-specific fields from a request URL. URL mask allows for routing to multiple resources on the same serverless platform without having to create multiple Network Endpoint Groups and backend resources. The fields parsed by this template are platform-specific and are as follows:
|
pscTargetService |
The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: |
pscData |
|
pscData.consumerPscAddress |
[Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. |
pscData.pscConnectionId |
[Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. |
pscData.pscConnectionStatus |
[Output Only] The connection status of the PSC Forwarding Rule. |
pscData.producerPort |
The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type |
Methods |
|
---|---|
|
Attach a network endpoint to the specified network endpoint group. |
|
Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it. |
|
Detach the network endpoint from the specified network endpoint group. |
|
Returns the specified network endpoint group. |
|
Creates a network endpoint group in the specified project using the parameters that are included in the request. |
|
Retrieves the list of network endpoint groups that are located in the specified project. |
|
Lists the network endpoints in the specified network endpoint group. |