Method: networkEndpointGroups.listNetworkEndpoints

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

string

Project ID for this request.
zone

string

The name of the zone where the network endpoint group is located. It should comply with RFC1035.
networkEndpointGroup

string

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

integer (uint32 format)

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
pageToken

string

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter

string

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 =, !=, >, <, <=, >= or :.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use:

labels.owner:*

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example:

(scheduling.automaticRestart = true)
(cpuPlatform = "Intel Skylake")

By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example:

(cpuPlatform = "Intel Skylake") OR
(cpuPlatform = "Intel Broadwell") AND
(scheduling.automaticRestart = true)

If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples:

fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal")

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 name ne .*instance.

You cannot combine constraints on multiple fields using regular expressions.
orderBy

string

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 orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
returnPartialSuccess

boolean

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

enum

Optional query parameter for showing the health status of each network endpoint. Valid options are SKIP or SHOW. If you don't specify this parameter, the health status of network endpoints will not be provided.
endpointFilters[].networkEndpoint.ipAddress

string

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 GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork.
endpointFilters[].networkEndpoint.ipv6Address

string

Optional IPv6 address of network endpoint.
endpointFilters[].networkEndpoint.fqdn

string

Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT.
endpointFilters[].networkEndpoint.port

integer

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 GCE_VM_IP.
endpointFilters[].networkEndpoint.clientDestinationPort

integer

Represents the port number to which PSC consumer sends packets.

Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type.
endpointFilters[].networkEndpoint.instance

string

The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT.

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 ipAddress is specified, it must belongs to the VM instance.

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

map (key: string, value: string)

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

string

[Output Only] The resource type, which is always compute#networkEndpointGroupsListNetworkEndpoints for the list of network endpoints in the specified network endpoint group.
id

string

[Output Only] Unique identifier for the resource; defined by the server.
items[]

object

A list of NetworkEndpointWithHealthStatus resources.
items[].networkEndpoint

object

[Output only] The network endpoint;
items[].networkEndpoint.ipAddress

string

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 GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork.
items[].networkEndpoint.ipv6Address

string

Optional IPv6 address of network endpoint.
items[].networkEndpoint.fqdn

string

Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT.
items[].networkEndpoint.port

integer

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 GCE_VM_IP.
items[].networkEndpoint.clientDestinationPort

integer

Represents the port number to which PSC consumer sends packets.

Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type.
items[].networkEndpoint.instance

string

The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT.

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 ipAddress is specified, it must belongs to the VM instance.

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

map (key: string, value: string)

Metadata defined as annotations on the network endpoint.
items[].healths[]

object

[Output only] The health status of network endpoint;
items[].healths[].forwardingRule

object

URL of the forwarding rule associated with the health state of the network endpoint.
items[].healths[].forwardingRule.forwardingRule

string
items[].healths[].backendService

object

URL of the backend service associated with the health state of the network endpoint.
items[].healths[].backendService.backendService

string
items[].healths[].healthCheck

object

URL of the health check associated with the health state of the network endpoint.
items[].healths[].healthCheck.healthCheck

string
items[].healths[].healthCheckService

object

URL of the health check service associated with the health state of the network endpoint.
items[].healths[].healthCheckService.healthCheckService

string
items[].healths[].healthState

enum

Health state of the network endpoint determined based on the health checks configured.
items[].healths[].ipv6HealthState

enum

Health state of the ipv6 network endpoint determined based on the health checks configured.
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.
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.get

To find predefined roles that contain those permissions, see Compute Engine IAM Roles.