GoogleApi.Compute.V1.Api.InstanceGroups.compute_instance_groups_remove_instances

You're seeing just the function compute_instance_groups_remove_instances, go back to GoogleApi.Compute.V1.Api.InstanceGroups module for more information.
Link to this function

compute_instance_groups_remove_instances(connection, project, zone, instance_group, optional_params \\ [], opts \\ [])

View Source

Specs

compute_instance_groups_remove_instances(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Compute.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Compute.V1.Connection.t) - Connection to server

  • project (type: String.t) - Project ID for this request.

  • zone (type: String.t) - The name of the zone where the instance group is located.

  • instance_group (type: String.t) - The name of the instance group where the specified instances will be removed.

  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.

    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.

    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.

    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.

    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.

    • :requestId (type: String.t) - 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).

    • :body (type: GoogleApi.Compute.V1.Model.InstanceGroupsRemoveInstancesRequest.t) -

  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Compute.V1.Model.Operation{}} on success
  • {:error, info} on failure