- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Retrieves the list of network endpoint groups and sorts them by zone.
To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
.
HTTP request
GET https://compute.googleapis.com/compute/v1/projects/{project}/aggregated/networkEndpointGroups
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
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. |
includeAllScopes |
Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. |
serviceProjectNumber |
The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. |
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": { string: { "networkEndpointGroups": [ { "kind": string, "id": string, "creationTimestamp": string, "selfLink": string, "name": string, "description": string, "networkEndpointType": enum, "size": 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 }, "pscTargetService": string, "pscData": { "consumerPscAddress": string, "pscConnectionId": string, "pscConnectionStatus": enum, "producerPort": integer } } ], "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } }, ... }, "nextPageToken": string, "selfLink": string, "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] }, "unreachables": [ string ] } |
Fields | |
---|---|
kind |
[Output Only] The resource type, which is always |
id |
[Output Only] Unique identifier for the resource; defined by the server. |
items |
A list of NetworkEndpointGroupsScopedList resources. Key: The name of the scope that contains this set of network endpoint groups. |
items.networkEndpointGroups[] |
[Output Only] The list of network endpoint groups that are contained in this scope. |
items.networkEndpointGroups[].kind |
[Output Only] Type of the resource. Always |
items.networkEndpointGroups[].id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
items.networkEndpointGroups[].creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
items.networkEndpointGroups[].selfLink |
[Output Only] Server-defined URL for the resource. |
items.networkEndpointGroups[].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 |
items.networkEndpointGroups[].description |
An optional description of this resource. Provide this property when you create the resource. |
items.networkEndpointGroups[].networkEndpointType |
Type of network endpoints in this network endpoint group. Can be one of |
items.networkEndpointGroups[].size |
[Output only] Number of network endpoints in the network endpoint group. |
items.networkEndpointGroups[].region |
[Output Only] The URL of the region where the network endpoint group is located. |
items.networkEndpointGroups[].zone |
[Output Only] The URL of the zone where the network endpoint group is located. |
items.networkEndpointGroups[].network |
The URL of the network to which all network endpoints in the NEG belong. Uses |
items.networkEndpointGroups[].subnetwork |
Optional URL of the subnetwork to which all network endpoints in the NEG belong. |
items.networkEndpointGroups[].defaultPort |
The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either |
items.networkEndpointGroups[].annotations |
Metadata defined as annotations on the network endpoint group. |
items.networkEndpointGroups[].cloudRun |
Only valid when |
items.networkEndpointGroups[].cloudRun.service |
Cloud Run service is the main resource of Cloud Run. The Example value: "run-service". |
items.networkEndpointGroups[].cloudRun.tag |
Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The Example value: "revision-0010". |
items.networkEndpointGroups[].cloudRun.urlMask |
An URL mask is one of the main components of the Cloud Function. A template to parse For example, request URLs |
items.networkEndpointGroups[].appEngine |
Only valid when |
items.networkEndpointGroups[].appEngine.service |
Optional serving service. The Example value: |
items.networkEndpointGroups[].appEngine.version |
Optional serving version. The Example value: |
items.networkEndpointGroups[].appEngine.urlMask |
An URL mask is one of the main components of the Cloud Function. A template to parse For example, the request URLs |
items.networkEndpointGroups[].cloudFunction |
Only valid when |
items.networkEndpointGroups[].cloudFunction.function |
A user-defined name of the Cloud Function. The Example value: |
items.networkEndpointGroups[].cloudFunction.urlMask |
An URL mask is one of the main components of the Cloud Function. A template to parse For example, request URLs |
items.networkEndpointGroups[].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: |
items.networkEndpointGroups[].pscData |
|
items.networkEndpointGroups[].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. |
items.networkEndpointGroups[].pscData.pscConnectionId |
[Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. |
items.networkEndpointGroups[].pscData.pscConnectionStatus |
[Output Only] The connection status of the PSC Forwarding Rule. |
items.networkEndpointGroups[].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 |
items.warning |
[Output Only] An informational warning that replaces the list of network endpoint groups when the list is empty. |
items.warning.code |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
items.warning.message |
[Output Only] A human-readable description of the warning code. |
items.warning.data[] |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
items.warning.data[].key |
[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 |
items.warning.data[].value |
[Output Only] A warning data value corresponding to the key. |
nextPageToken |
[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than |
selfLink |
[Output Only] Server-defined URL for this resource. |
warning |
[Output Only] Informational warning message. |
warning.code |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
warning.message |
[Output Only] A human-readable description of the warning code. |
warning.data[] |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
warning.data[].key |
[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 |
warning.data[].value |
[Output Only] A warning data value corresponding to the key. |
unreachables[] |
[Output Only] Unreachable resources. |
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.