Method: globalNetworkEndpointGroups.detachNetworkEndpoints

Detach the network endpoint from the specified network endpoint group.

HTTP request

POST https://compute.s3nsapis.fr/compute/v1/projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints

The URL uses gRPC Transcoding syntax. To know more about valid error responses that can be thrown by this HTTP request, please refer to the service error catalog

Path parameters

Parameters
project

string

Project ID for this request.
networkEndpointGroup

string

The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.

Query parameters

Parameters
requestId

string

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

The request body contains data with the following structure:

JSON representation 
{
  "networkEndpoints": [
    {
      "ipAddress": string,
      "ipv6Address": string,
      "fqdn": string,
      "port": integer,
      "clientDestinationPort": integer,
      "instance": string,
      "annotations": {
        string: string,
        ...
      }
    }
  ]
}
Fields
networkEndpoints[].ipAddress

string

Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used.

This field is redundant and need not be set for network endpoints of type

GCE_VM_IP

. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork.
networkEndpoints[].ipv6Address

string

Optional IPv6 address of network endpoint.
networkEndpoints[].fqdn

string

Optional fully qualified domain name of network endpoint. This can only be specified when

NetworkEndpointGroup.network_endpoint_type

is

NON_GCP_FQDN_PORT

.
networkEndpoints[].port

integer

Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used.

This field can not be set for network endpoints of type

GCE_VM_IP

.
networkEndpoints[].clientDestinationPort

integer

Represents the port number to which PSC consumer sends packets.

Optional. Only valid for network endpoint groups created with

GCE_VM_IP_PORTMAP

endpoint type.
networkEndpoints[].instance

string

The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type

GCE_VM_IP

and

GCE_VM_IP_PORT

.

The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the

ipAddress

is specified, it must belongs to the VM instance.

The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance.
networkEndpoints[].annotations

map (key: string, value: string)

Optional metadata defined as annotations on the network endpoint.

Response body

If successful, the response body contains an instance of Operation.

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.globalNetworkEndpointGroups.detachNetworkEndpoints

To find predefined roles that contain those permissions, see Compute Engine IAM Roles.