Ocean GKE

Detach Instances

Detach instances from your Ocean cluster.

put/ocean/gcp/k8s/cluster/{oceanClusterId}/detachInstances

Request

  • Base URL
    https://api.spotinst.io
  • URL
    https://api.spotinst.io/ocean/gcp/k8s/cluster/{oceanClusterId}/detachInstances
  • Auth
    HTTP bearer

Parameters

#/paths/~1azure~1costs/get/parameters/0 (unresolved $ref)
#/paths/~1ocean~1aws~1k8s~1cluster~1%7BoceanClusterId%7D/get/parameters/1 (unresolved $ref)

Request body

instancesToDetachstring[] required

Array of instance identifiers to be detached.

shouldTerminateInstancesboolean

Determines whether the detached instances should be terminated or not. (Default true)

shouldDecrementTargetCapacityboolean

Determines whether the Ocean cluster's target capacity should be decremented. (Default false)

drainingTimeoutinteger

(Applies only if shouldTerminateInstances is on) The draining timeout (in seconds) before terminating the instance.

Example request

{
  "instancesToDetach": [
    "sin-9d317117a0df-oesg-02cff6a8",
    "sin-49784809d76a-oesg-02cff6a8"
  ],
  "shouldTerminateInstances": true
}

Changes

No recorded changes to this operation across all 12 revisions of this API.