Method: instanceGroupManagers.deleteInstances

Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the

targetSize

of the managed instance group by the number of instances that you delete. This operation is marked as

DONE

when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the

deleting

action with the listmanagedinstances method.

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 has elapsed before the VM instance is removed or deleted.

You can specify a maximum of 1000 instances with this method per request.

HTTP request

POST https://compute.s3nsapis.fr/compute/v1/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances

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 managed instance group is located.
instanceGroupManager

string

The name of the managed instance group.

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

  • compute.instanceGroupManagers.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": [
    string
  ],
  "skipInstancesOnValidationError": boolean
}
Fields
instances[]

string

The URLs of one or more instances to delete. This can be a full URL or a partial URL, such as

zones/[ZONE]/instances/[INSTANCE_NAME]

. Queued instances do not have URL and can be deleted only by name. One cannot specify both URLs and names in a single request.
skipInstancesOnValidationError

boolean

Specifies whether the request should proceed despite the inclusion of instances that are not members of the group or that are already in the process of being deleted or abandoned. If this field is set to false and such an instance is specified in the request, the operation fails. The operation always fails if the request contains a malformed instance URL or a reference to an instance that exists in a zone or region other than the group's zone or region.

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.