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/{resourceId}/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.
resourceId

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

number (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. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison 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.

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).
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.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "healthStatus": enum
}
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 specifiy this parameter, the health status of network endpoints will not be provided.

Response body

If successful, the response body contains data with the following structure:

JSON representation 
{
  "id": string,
  "items": [
    {
      "networkEndpoint": {
        "ipAddress": string,
        "port": number,
        "instance": string
      },
      "healths": [
        {
          "forwardingRule": {
            "forwardingRule": string
          },
          "backendService": {
            "backendService": string
          },
          "healthCheck": {
            "healthCheck": string
          },
          "healthState": enum
        }
      ]
    }
  ],
  "nextPageToken": string,
  "warning": {
    "code": enum,
    "message": string,
    "data": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "kind": string
}
Fields
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.

items[].networkEndpoint.port

number

Optional port number of network endpoint. If not specified and the NetworkEndpointGroup.network_endpoint_type is GCE_IP_PORT, the defaultPort for the network endpoint group will be used.

items[].networkEndpoint.instance

string

The name for a specific VM instance that the IP address belongs to. This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group.

The name must be 1-63 characters long, and comply with RFC1035.
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[].healthState

enum

Health state of the 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.

kind

string

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

Authorization Scopes

Requires one of the following OAuth scopes:

  • 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 Google IAM permissions:

  • compute.networkEndpointGroups.get

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

هل كانت هذه الصفحة مفيدة؟ يرجى تقييم أدائنا:

إرسال تعليقات حول...

هذه الصفحة
تعليقات عن الوثائق
Compute Engine Documentation
تعليقات عن المنتج