- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Retrieves the list of network endpoint groups that are located in the specified project and zone.
HTTP request
GET https://compute.googleapis.com/compute/beta/projects/{project}/zones/{zone}/networkEndpointGroups
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project
|
Project ID for this request. |
zone
|
The name of the zone where the network endpoint group is located. It should comply with RFC1035. |
Query parameters
Parameters | |
---|---|
maxResults
|
The maximum number of results per page that should be returned. If the number of available results is larger than |
pageToken
|
Specifies a page token to use. Set |
filter
|
A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160 . These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either For example, if you are filtering Compute Engine instances, you can exclude instances named The
You can also filter nested fields. For example, you could specify To filter on multiple expressions, provide each separate expression within parentheses. For example:
By default, each expression is an
If you want to use a regular expression, use the The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use You cannot combine constraints on multiple fields using regular expressions. |
orderBy
|
Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using Currently, only sorting by |
returnPartialSuccess
|
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "kind" : string , "id" : string , "items" : [ { "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 } } ] , "nextPageToken" : string , "selfLink" : string , "warning" : { "code" : enum , "message" : string , "data" : [ { "key" : string , "value" : string } ] } } |
kind
string
[Output Only] The resource type, which is always compute#networkEndpointGroupList
for network endpoint group lists.
id
string
[Output Only] Unique identifier for the resource; defined by the server.
items[]
object
A list of NetworkEndpointGroup resources.
items[].kind
string
[Output Only] Type of the resource. Always compute#networkEndpointGroup
for network endpoint group.
items[].id
string ( uint64
format)
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
items[].creationTimestamp
string
[Output Only] Creation timestamp in RFC3339 text format.
items[].selfLink
string
[Output Only] Server-defined URL for the resource.
items[].name
string
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 [a-z]([-a-z0-9]*[a-z0-9])?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
items[].description
string
An optional description of this resource. Provide this property when you create the resource.
items[].networkEndpointType
enum
Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP
, GCE_VM_IP_PORT
, NON_GCP_PRIVATE_IP_PORT
, INTERNET_FQDN_PORT
, INTERNET_IP_PORT
, SERVERLESS
, PRIVATE_SERVICE_CONNECT
, GCE_VM_IP_PORTMAP
.
items[].size
integer
[Output only] Number of network endpoints in the network endpoint group.
items[].loadBalancer
(deprecated)
object
This field is only valid when the network endpoint group is used for load balancing. [Deprecated] This field is deprecated.
items[].loadBalancer
(deprecated)
.zone
(deprecated)
string
[Output Only] The URL of the zone where the network endpoint group is located. [Deprecated] This field is deprecated.
items[].loadBalancer
(deprecated)
.network
(deprecated)
string
The URL of the network to which all network endpoints in the NEG belong. Uses default
project network if unspecified. [Deprecated] This field is deprecated.
items[].loadBalancer
(deprecated)
.subnetwork
(deprecated)
string
Optional URL of the subnetwork to which all network endpoints in the NEG belong. [Deprecated] This field is deprecated.
items[].loadBalancer
(deprecated)
.defaultPort
(deprecated)
integer
The default port used if the port number is not specified in the network endpoint.
If the network endpoint type is either GCE_VM_IP
, SERVERLESS
or PRIVATE_SERVICE_CONNECT
, this field must not be specified. [Deprecated] This field is deprecated.
items[].region
string
[Output Only] The URL of the region where the network endpoint group is located.
items[].zone
string
[Output Only] The URL of the zone where the network endpoint group is located.
items[].network
string
The URL of the network to which all network endpoints in the NEG belong. Uses default
project network if unspecified.
items[].subnetwork
string
Optional URL of the subnetwork to which all network endpoints in the NEG belong.
items[].defaultPort
integer
The default port used if the port number is not specified in the network endpoint.
If the network endpoint type is either GCE_VM_IP
, SERVERLESS
or PRIVATE_SERVICE_CONNECT
, this field must not be specified.
items[].annotations
map (key: string, value: string)
Metadata defined as annotations on the network endpoint group.
items[].cloudRun
object
Only valid when networkEndpointType
is SERVERLESS
. Only one of
cloudRun
, appEngine
or cloudFunction
may be set.
items[].cloudRun.service
string
Cloud Run service is the main resource of Cloud Run.
The service
must be 1-63 characters long, and comply with RFC1035
.
Example value: "run-service".
items[].cloudRun.tag
string
Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information.
The tag
must be 1-63 characters long, and comply with RFC1035
.
Example value: "revision-0010".
items[].cloudRun.urlMask
string
An URL mask is one of the main components of the Cloud Function.
A template to parse <service>
and <tag>
fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services.
For example, request URLs foo1.domain.com/bar1
and foo1.domain.com/bar2
can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask <tag>.domain.com/<service>
. The URL mask will parse them to { service="bar1", tag="foo1" }
and { service="bar2", tag="foo2" }
respectively.
items[].appEngine
object
Only valid when networkEndpointType
is SERVERLESS
. Only one of cloudRun
, appEngine
or cloudFunction
may be set.
items[].appEngine.service
string
Optional serving service .
The service
name is case-sensitive and must be 1-63 characters long.
Example value: default
, my-service
.
items[].appEngine.version
string
Optional serving version .
The version
name is case-sensitive and must be 1-100 characters long.
Example value: v1
, v2
.
items[].appEngine.urlMask
string
An URL mask is one of the main components of the Cloud Function.
A template to parse service
and version
fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services.
For example, the request URLs foo1-dot-appname.appspot.com/v1
and foo1-dot-appname.appspot.com/v2
can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>
. The URL mask will parse them to { service = "foo1", version = "v1" }
and { service = "foo1", version = "v2" }
respectively.
items[].cloudFunction
object
Only valid when networkEndpointType
is SERVERLESS
. Only one of cloudRun
, appEngine
or cloudFunction
may be set.
items[].cloudFunction.function
string
A user-defined name of the Cloud Function .
The function
name is case-sensitive and must be 1-63 characters long.
Example value: func1
.
items[].cloudFunction.urlMask
string
An URL mask is one of the main components of the Cloud Function.
A template to parse function
field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services.
For example, request URLs mydomain.com/function1
and mydomain.com/function2
can be backed by the same Serverless NEG with URL mask /<function>
. The URL mask will parse them to { function = "function1" }
and { function = "function2" }
respectively.
items[].serverlessDeployment
object
Only valid when networkEndpointType
is SERVERLESS
. Only one of cloudRun
, appEngine
, cloudFunction
or serverlessDeployment
may be set.
items[].serverlessDeployment.platform
string
The platform of the backend target(s) of this NEG. The only supported value is API Gateway: apigateway.googleapis.com
.
items[].serverlessDeployment.resource
string
The user-defined name of the workload/instance. This value must be provided explicitly or in the urlMask
. The resource identified by this value is platform-specific and is as follows:
- API Gateway: The
gateway
ID - App Engine: The
service
name - Cloud Functions: The
function
name - Cloud Run: The
service
name
items[].serverlessDeployment.version
string
The optional resource version. The version identified by this value is platform-specific and is follows:
- API Gateway: Unused
- App Engine: The service version
- Cloud Functions: Unused
- Cloud Run: The service tag
items[].serverlessDeployment.urlMask
string
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:
- API Gateway: The
gateway
ID - App Engine: The
service
andversion
- Cloud Functions: The
function
name - Cloud Run: The
service
andtag
items[].pscTargetService
string
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: asia-northeast3-cloudkms.googleapis.com
items[].pscData
object
items[].pscData.consumerPscAddress
string
[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.
items[].pscData.pscConnectionId
string ( uint64
format)
[Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer.
items[].pscData.pscConnectionStatus
enum
[Output Only] The connection status of the PSC Forwarding Rule.
nextPageToken
string
[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults
, use the nextPageToken
as a value for the query parameter pageToken
in the next list request. Subsequent list requests will have their own nextPageToken
to continue paging through the results.
selfLink
string
[Output Only] Server-defined URL for this resource.
warning
object
[Output Only] Informational warning message.
warning.code
enum
[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE
if there are no results in the response.
warning.message
string
[Output Only] A human-readable description of the warning code.
warning.data[]
object
[Output Only] Metadata about this warning in key: value
format. For example:
"data": [ { "key": "scope", "value": "zones/us-east1-d" }
warning.data[].key
string
[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope
and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
warning.data[].value
string
[Output Only] A warning data value corresponding to the key.
Authorization scopes
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/compute.readonly
-
https://www.googleapis.com/auth/compute
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
IAM Permissions
In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:
-
compute.networkEndpointGroups.list
To find predefined roles that contain those permissions, see Compute Engine IAM Roles .