Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-131,0021,0174.3 MB
globalNetworkEndpointGroups

Creates a network endpoint group in the specified project using the parameters that are included in the request.

Note: Use the following APIs to manage network endpoint groups:

To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity NEGs): zonal API

To manage NEGs with regional scope (such as regional internet NEGs, serverless NEGs, Private Service Connect NEGs): regional API

To manage NEGs with global scope (such as global internet NEGs):global API

post/projects/{project}/global/networkEndpointGroups

Path parameters

projectstring required

Project ID for this request.

Query parameters

requestIdstring

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Request body

descriptionstring

An optional description of this resource. Provide this property when you create the resource.

regionstring

Output only. [Output Only] The URL of theregion where the network endpoint group is located.

defaultPortinteger

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.

creationTimestampstring

Output only. [Output Only] Creation timestamp inRFC3339 text format.

namestring

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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.

networkEndpointType'GCE_VM_IP' | 'GCE_VM_IP_PORT' | 'GCE_VM_IP_PORTMAP' | 'INTERNET_FQDN_PORT' | 'INTERNET_IP_PORT' | 'NON_GCP_PRIVATE_IP_PORT' | 'PRIVATE_SERVICE_CONNECT' | 'SERVERLESS'

Type of network endpoints in this network endpoint group. Can be one ofGCE_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.

sizeinteger

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

kindstring

Output only. [Output Only] Type of the resource. Alwayscompute#networkEndpointGroup for network endpoint group.

networkstring

The URL of the network to which all network endpoints in the NEG belong. For networkEndpointType GCE_VM_IP_PORT,GCE_VM_IP_PORTMAP or NON_GCP_PRIVATE_IP_PORT, if this field is not specified, a default network will be used. This field cannot be set for NEGs with networkEndpointType set toSERVERLESS or PRIVATE_SERVICE_CONNECT and for global NEGs. For all other network endpoint types, this field is required.

idstring uint64

Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.

zonestring

Output only. [Output Only] The URL of thezone where the network endpoint group is located.

pscTargetServicestring

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

subnetworkstring

Optional URL of the subnetwork to which all network endpoints in the NEG belong.

annotationsobject

Optional. Metadata defined as annotations on the network endpoint group.

selfLinkstring

Output only. [Output Only] Server-defined URL for the resource.

Response

Successful response