Method: networkEndpointGroups.get

Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.

HTTP request

GET https://www.googleapis.com/compute/beta/projects/{project}/zones/{zone}/networkEndpointGroups/{resourceId}

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

Represents a collection of network endpoints.

JSON representation
{
  "id": string,
  "creationTimestamp": string,
  "selfLink": string,
  "name": string,
  "description": string,
  "networkEndpointType": enum,
  "size": number,
  "loadBalancer": {
    "zone": string,
    "network": string,
    "subnetwork": string,
    "defaultPort": number
  },
  "zone": string,
  "network": string,
  "subnetwork": string,
  "defaultPort": number,
  "kind": string
}
Fields
id

string (fixed64 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.

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. Currently the only supported value is GCE_VM_IP_PORT.

size

number

[Output only] Number of network endpoints in the network endpoint group.

loadBalancer
(deprecated)

object

This field is only valid when the network endpoint group is used for load balancing. [Deprecated] This field is deprecated.

loadBalancer
(deprecated).zone
(deprecated)

string

[Output Only] The URL of the zone where the network endpoint group is located. [Deprecated] This field is deprecated.

loadBalancer
(deprecated).network
(deprecated)

string

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
(deprecated).subnetwork
(deprecated)

string

Optional URL of the subnetwork to which all network endpoints in the NEG belong. [Deprecated] This field is deprecated.

loadBalancer
(deprecated).defaultPort
(deprecated)

number

The default port used if the port number is not specified in the network endpoint. [Deprecated] This field is deprecated.

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

number

The default port used if the port number is not specified in the network endpoint.

kind

string

[Output Only] Type of the resource. Always compute#networkEndpointGroup for 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
Was this page helpful? Let us know how we did:

Send feedback about...

Compute Engine