SPspot
Elastigroup AWS

Deployment Actions

Apply a Detach action to a deployment

post/aws/ec2/group/{groupId}/roll/{rollId}/action

Request

  • Base URL
    https://api.spotinst.io
  • URL
    https://api.spotinst.io/aws/ec2/group/{groupId}/roll/{rollId}/action
  • Auth
    HTTP bearer

Path parameters

rollIdstring required

The deployment ID to call the action on

Query parameters

accountIdstring

ID of the account associated with your token

Parameters

#/paths/~1aws~1ec2~1group~1%7BgroupId%7D/put/parameters/0 (unresolved $ref)

Request body

actionTypestring

Sets the action that will take place, Accepted values are: DETACH_OLD, DETACH_NEW

shouldHandleAllBatchesboolean

Indicator if the action should apply to all batches of the deployment or only the latest batch

drainingTimeoutinteger

Indicates (in seconds) the timeout to wait until instance are detached

shouldDecrementTargetCapacityboolean

Example request

{
  "actionType": "DETACH_NEW",
  "shouldHandleAllBatches": true,
  "drainingTimeout": 200,
  "shouldDecrementTargetCapacity": true
}

Response

Deployment Actions Response

Example response

{
  "request": {
    "id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
    "url": "/aws/ec2/group/sig-1b656b92/roll/sbgd-aafb7671/action",
    "method": "POST",
    "timestamp": "2016-01-21T17:12:51.451Z"
  },
  "response": {
    "status": {
      "code": 200,
      "message": "OK"
    },
    "kind": "spotinst:aws:ec2:group:roll:action",
    "items": [
      {
        "groupId": "sig-1b656b92",
        "rollId": "sbgd-aafb7671",
        "actionType": "DETACH_NEW"
      }
    ],
    "count": 1
  }
}

Changes

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