Stay organized with collections Save and categorize content based on your preferences.
Returns the specified network endpoint group.
HTTP requestGET https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}
The URL uses gRPC Transcoding syntax.
Path parameters Parametersproject
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. It should comply with RFC1035.
Request bodyThe request body must be empty.
Response bodyRepresents a collection of network endpoints.
A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview.
If successful, the response body contains data with the following structure:
JSON representation{ "kind": string, "id": string, "creationTimestamp": string, "selfLink": string, "name": string, "description": string, "networkEndpointType": enum, "size": 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 }, "pscTargetService": string, "pscData": { "consumerPscAddress": string, "pscConnectionId": string, "pscConnectionStatus": enum, "producerPort": integer } }Fields
kind
string
[Output Only] Type of the resource. Always compute#networkEndpointGroup
for network endpoint group.
id
string (uint64 format)
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
creationTimestamp
string
[Output Only] Creation timestamp in RFC3339 text format.
selfLink
string
[Output Only] Server-defined URL for the resource.
name
string
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 [a-z]([-a-z0-9]*[a-z0-9])?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
description
string
An optional description of this resource. Provide this property when you create the resource.
networkEndpointType
enum
Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP
, GCE_VM_IP_PORT
, NON_GCP_PRIVATE_IP_PORT
, INTERNET_FQDN_PORT
, INTERNET_IP_PORT
, SERVERLESS
, PRIVATE_SERVICE_CONNECT
, GCE_VM_IP_PORTMAP
.
size
integer
[Output only] Number of network endpoints in the network endpoint group.
region
string
[Output Only] The URL of the region where the network endpoint group is located.
zone
string
[Output Only] The URL of the zone where the network endpoint group is located.
network
string
The URL of the network to which all network endpoints in the NEG belong. Uses default
project network if unspecified.
subnetwork
string
Optional URL of the subnetwork to which all network endpoints in the NEG belong.
defaultPort
integer
The default port used if the port number is not specified in the network endpoint.
Optional. If the network endpoint type is either GCE_VM_IP
, SERVERLESS
or PRIVATE_SERVICE_CONNECT
, this field must not be specified.
annotations
map (key: string, value: string)
Optional. Metadata defined as annotations on the network endpoint group.
cloudRun
object
Optional. Only valid when networkEndpointType
is SERVERLESS
. Only one of
cloudRun
, appEngine
or cloudFunction
may be set.
cloudRun.service
string
Cloud Run service is the main resource of Cloud Run.
The service
must be 1-63 characters long, and comply with RFC1035.
Example value: "run-service".
cloudRun.tag
string
Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information.
The tag
must be 1-63 characters long, and comply with RFC1035.
Example value: "revision-0010".
cloudRun.urlMask
string
An URL mask is one of the main components of the Cloud Function.
A template to parse <service>
and <tag>
fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services.
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 <tag>.domain.com/<service>
. The URL mask will parse them to { service="bar1", tag="foo1" }
and { service="bar2", tag="foo2" }
respectively.
appEngine
object
Optional. Only valid when networkEndpointType
is SERVERLESS
. Only one of cloudRun
, appEngine
or cloudFunction
may be set.
appEngine.service
string
Optional serving service.
The service
name is case-sensitive and must be 1-63 characters long.
Example value: default
, my-service
.
appEngine.version
string
Optional serving version.
The version
name is case-sensitive and must be 1-100 characters long.
Example value: v1
, v2
.
appEngine.urlMask
string
An URL mask is one of the main components of the Cloud Function.
A template to parse service
and version
fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services.
For example, the request URLs foo1-dot-appname.appspot.com/v1
and foo1-dot-appname.appspot.com/v2
can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>
. The URL mask will parse them to { service = "foo1", version = "v1" }
and { service = "foo1", version = "v2" }
respectively.
cloudFunction
object
Optional. Only valid when networkEndpointType
is SERVERLESS
. Only one of cloudRun
, appEngine
or cloudFunction
may be set.
cloudFunction.function
string
A user-defined name of the Cloud Function.
The function
name is case-sensitive and must be 1-63 characters long.
Example value: func1
.
cloudFunction.urlMask
string
An URL mask is one of the main components of the Cloud Function.
A template to parse function
field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services.
For example, request URLs mydomain.com/function1
and mydomain.com/function2
can be backed by the same Serverless NEG with URL mask /<function>
. The URL mask will parse them to { function = "function1" }
and { function = "function2" }
respectively.
pscTargetService
string
The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com
.
Optional. Only valid when networkEndpointType
is PRIVATE_SERVICE_CONNECT
.
pscData
object
Optional. Only valid when networkEndpointType
is PRIVATE_SERVICE_CONNECT
.
pscData.consumerPscAddress
string
[Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB.
pscData.pscConnectionId
string (uint64 format)
[Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer.
pscData.pscConnectionStatus
enum
[Output Only] The connection status of the PSC Forwarding Rule.
pscData.producerPort
integer
The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type
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 PermissionsIn 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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-28 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-28 UTC."],[[["This page details how to retrieve a specific network endpoint group (NEG) using a `GET` HTTP request."],["The request requires parameters such as the project ID, zone, and the name of the network endpoint group."],["The request body must be empty, and a successful response will contain data about the NEG including details such as its type, size, location, and associated metadata, in a specified JSON format."],["Accessing this information requires specific authorization scopes or IAM permissions, including `compute.networkEndpointGroups.get` or relevant roles."],["The various attributes of the endpoint are further detailed, such as `cloudRun`, `appEngine` and `cloudFunction`, which can be specified when `networkEndpointType` is `SERVERLESS`, and attributes specifying `pscData` when the `networkEndpointType` is `PRIVATE_SERVICE_CONNECT`."]]],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4