- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization Scopes
- IAM Permissions
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 |
Project ID for this request. |
zone |
The name of the zone where the network endpoint group is located. It should comply with RFC1035. |
resourceId |
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. 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 For example, if you are filtering Compute Engine instances, you can exclude instances named You can also filter nested fields. For example, you could specify To filter on multiple expressions, provide each separate expression within parentheses. For example, |
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 |
Request body
The request body contains data with the following structure:
JSON representation | |
---|---|
{ "healthStatus": enum } |
Fields | |
---|---|
healthStatus |
Optional query parameter for showing the health status of each network endpoint. Valid options are |
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 |
[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. |
items[].networkEndpoint.port |
Optional port number of network endpoint. If not specified and the NetworkEndpointGroup.network_endpoint_type is |
items[].networkEndpoint.instance |
The name for a specific VM instance that the IP address belongs to. This is required for network endpoints of type The name must be 1-63 characters long, and comply with RFC1035. |
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[].healthState |
Health state of the 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. |
kind |
[Output Only] The resource type, which is always |
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.