- HTTP request
- Path parameters
- Request body
- Response body
- Authorization Scopes
- IAM Permissions
- Examples
- Try it!
Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list()
request.
HTTP request
GET https://compute.googleapis.com/compute/beta/projects/{project}/zones/{zone}/networkEndpointGroups/{resourceId}
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. It should comply with RFC1035. |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
JSON representation | |
---|---|
{ "id": string, "creationTimestamp": string, "selfLink": string, "name": string, "description": string, "networkEndpointType": enum, "size": integer, "loadBalancer": { "zone": string, "network": string, "subnetwork": string, "defaultPort": 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 }, "kind": string } |
Fields | |
---|---|
id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
selfLink |
[Output Only] Server-defined URL for the resource. |
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 |
description |
An optional description of this resource. Provide this property when you create the resource. |
networkEndpointType |
Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, or SERVERLESS. |
size |
[Output only] Number of network endpoints in the network endpoint group. |
loadBalancer |
This field is only valid when the network endpoint group is used for load balancing. [Deprecated] This field is deprecated. |
loadBalancer |
[Output Only] The URL of the zone where the network endpoint group is located. [Deprecated] This field is deprecated. |
loadBalancer |
The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. [Deprecated] This field is deprecated. |
loadBalancer |
Optional URL of the subnetwork to which all network endpoints in the NEG belong. [Deprecated] This field is deprecated. |
loadBalancer |
The default port used if the port number is not specified in the network endpoint. [Deprecated] This field is deprecated. |
region |
[Output Only] The URL of the region where the network endpoint group is located. |
zone |
[Output Only] The URL of the zone where the network endpoint group is located. |
network |
The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. |
subnetwork |
Optional URL of the subnetwork to which all network endpoints in the NEG belong. |
defaultPort |
The default port used if the port number is not specified in the network endpoint. |
annotations |
Metadata defined as annotations on the network endpoint group. An object containing a list of |
cloudRun |
Only valid when |
cloudRun.service |
Cloud Run service is the main resource of Cloud Run. The Example value: "run-service". |
cloudRun.tag |
Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The Example value: "revision-0010". |
cloudRun.urlMask |
A template to parse For example, request URLs "foo1.domain.com/bar1" and "foo1.domain.com/bar2" can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask " |
appEngine |
Only valid when |
appEngine.service |
Optional serving service. The Example value: "default", "my-service". |
appEngine.version |
Optional serving version. The Example value: "v1", "v2". |
appEngine.urlMask |
A template to parse For example, the request URLs " |
cloudFunction |
Only valid when |
cloudFunction.function |
A user-defined name of the Cloud Function. The Example value: "func1". |
cloudFunction.urlMask |
A template to parse For example, request URLs " |
kind |
[Output Only] Type of the resource. 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 IAM permissions:
compute.networkEndpointGroups.get
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.