GOgoogle
networkEndpointGroups

POST /projects/{project}/zones/{zone}/networkEndpointGroups

Changed on

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

Request

  • Base URL
    https://compute.googleapis.com/compute/v1
  • URL
    https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/networkEndpointGroups
  • Auth
    • OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/cloud-platform
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/compute
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/compute

Path parameters

projectstring required

Project ID for this request.

zonestring required

The name of the zone where you want to create the network endpoint group. It should comply with RFC1035.

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

annotationsobject

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

creationTimestampstring

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

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.

descriptionstring

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

idstring uint64

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

kindstring

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

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.

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.

networkEndpointType'GCE_VM_IP' | 'GCE_VM_IP_DEDICATED_BACKEND' | '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.

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.

regionstring

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

selfLinkstring

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

sizeinteger

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

subnetworkstring

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

zonestring

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

Response

Successful response

clientOperationIdstring

[Output Only] The value of requestId if you provided it in the request. Not present otherwise.

creationTimestampstring

[Deprecated] This field is deprecated.

descriptionstring

[Output Only] A textual description of the operation, which is set when the operation is created.

endTimestring

[Output Only] The time that this operation was completed. This value is inRFC3339 text format.

httpErrorMessagestring

[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.

httpErrorStatusCodeinteger

[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.

idstring uint64

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

insertTimestring

[Output Only] The time that this operation was requested. This value is inRFC3339 text format.

kindstring

Output only. [Output Only] Type of the resource. Always compute#operation for Operation resources.

namestring

[Output Only] Name of the operation.

operationGroupIdstring

Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a bulkInsert API request.

operationTypestring

[Output Only] The type of operation, such as insert, update, or delete, and so on.

progressinteger

[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

regionstring

[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

selfLinkstring

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

startTimestring

[Output Only] The time that this operation was started by the server. This value is inRFC3339 text format.

status'DONE' | 'PENDING' | 'RUNNING'

[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.

statusMessagestring

[Output Only] An optional textual description of the current status of the operation.

targetIdstring uint64

[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

targetLinkstring

[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.

userstring

[Output Only] User who requested the operation, for example: user@example.com or alice_smith_identifier (global/workforcePools/example-com-us-employees).

zonestring

[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Changes

  • 8b85e897d3dcRevision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/compute was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/compute was removed from the endpoint's security scheme Oauth2c

  • 48929bf89eebRevision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/compute was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/compute was removed from the endpoint's security scheme Oauth2c