- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Lists the network endpoints in the specified network endpoint group.
HTTP request
POST https://compute.googleapis.com/compute/beta/projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints
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. |
networkEndpointGroup |
The name of the network endpoint group from which you want to generate a list of included network endpoints. 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 contains data with the following structure:
JSON representation |
---|
{ "healthStatus": enum, "endpointFilters": [ { "networkEndpoint": { "ipAddress": string, "ipv6Address": string, "fqdn": string, "port": integer, "clientDestinationPort": integer, "instance": string, "annotations": { string: string, ... } } } ] } |
Fields | |
---|---|
healthStatus |
Optional query parameter for showing the health status of each network endpoint. Valid options are |
endpointFilters[].networkEndpoint.ipAddress |
Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type |
endpointFilters[].networkEndpoint.ipv6Address |
Optional IPv6 address of network endpoint. |
endpointFilters[].networkEndpoint.fqdn |
Optional fully qualified domain name of network endpoint. This can only be specified when |
endpointFilters[].networkEndpoint.port |
Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type |
endpointFilters[].networkEndpoint.clientDestinationPort |
Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with |
endpointFilters[].networkEndpoint.instance |
The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. |
endpointFilters[].networkEndpoint.annotations |
Metadata defined as annotations on the network endpoint. |
Response body
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "kind": string, "id": string, "items": [ { "networkEndpoint": { "ipAddress": string, "ipv6Address": string, "fqdn": string, "port": integer, "clientDestinationPort": integer, "instance": string, "annotations": { string: string, ... } }, "healths": [ { "forwardingRule": { "forwardingRule": string }, "backendService": { "backendService": string }, "healthCheck": { "healthCheck": string }, "healthCheckService": { "healthCheckService": string }, "healthState": enum, "ipv6HealthState": enum } ] } ], "nextPageToken": string, "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": 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 NetworkEndpointWithHealthStatus resources. |
items[].networkEndpoint |
[Output only] The network endpoint; |
items[].networkEndpoint.ipAddress |
Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type |
items[].networkEndpoint.ipv6Address |
Optional IPv6 address of network endpoint. |
items[].networkEndpoint.fqdn |
Optional fully qualified domain name of network endpoint. This can only be specified when |
items[].networkEndpoint.port |
Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type |
items[].networkEndpoint.clientDestinationPort |
Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with |
items[].networkEndpoint.instance |
The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. |
items[].networkEndpoint.annotations |
Metadata defined as annotations on the network endpoint. |
items[].healths[] |
[Output only] The health status of network endpoint; |
items[].healths[].forwardingRule |
URL of the forwarding rule associated with the health state of the network endpoint. |
items[].healths[].forwardingRule.forwardingRule |
|
items[].healths[].backendService |
URL of the backend service associated with the health state of the network endpoint. |
items[].healths[].backendService.backendService |
|
items[].healths[].healthCheck |
URL of the health check associated with the health state of the network endpoint. |
items[].healths[].healthCheck.healthCheck |
|
items[].healths[].healthCheckService |
URL of the health check service associated with the health state of the network endpoint. |
items[].healths[].healthCheckService.healthCheckService |
|
items[].healths[].healthState |
Health state of the network endpoint determined based on the health checks configured. |
items[].healths[].ipv6HealthState |
Health state of the ipv6 network endpoint determined based on the health checks configured. |
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 |
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. |
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.get
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.