Method: instanceGroups.removeInstances

Removes one or more instances from the specified instance group, but does not delete those instances.

If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted.

HTTP request

POST https://compute.s3nsapis.fr/compute/v1/projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances

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

string

The name of the zone where the instance group is located.
instanceGroup

string

The name of the instance group where the specified instances will be removed.

Authorization requires the following IAM permission on the specified resource instanceGroup:

  • compute.instanceGroups.update

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 
{
  "instances": [
    {
      object (InstanceReference)
    }
  ]
}
Fields
instances[]

object (InstanceReference)

The list of instances to remove from the instance group.

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.