fbpx
POSThttps://api.spotinst.io/aws/ec2/group/{GROUP_ID}/clusterRoll?accountId={ACCOUNT_ID}

Initiate a cluster roll for an Elastigroup with ECS cluster

URL Parameters

Parameter Type Description
GROUP_ID * String

The Elastigroup ID you want to query

Example: sig-test1234
ACCOUNT_ID * String

The Spotinst accountId associated with your token.

Example: act-123abc
Request

Headers
{
  "Authorization": "Bearer ${token}",
  "Content-Type": "application/json"
}
Body
Copied!
Downloaded!
{ 
	"roll" : 
	{
		"batchSizePercentage" : 20,
		"comment": "This is why I deployed my cluster."
	}
}
Attribute Type Description
roll * Object

roll.batchSizePercentage * Integer

Size of patch for roll as a percent

Example: 20
roll.comment String

Add a comment description for the roll. comment should be limit to 256 chars.

Response - 200

Body
Copied!
Downloaded!
{
    "id": "scr-5aaf854e",
    "status": "STARTING",
    "currentBatch": 1,
    "numOfBatches": 5,
	"comment": "This is why I deployed my cluster.",
    "progress": {
    	"unit": "percentage",
		"value": 0
	},
	"groupId": "sig-43a8a5ee",
	"createdAt": "2019-03-24T15:46:09.000Z",
	"updatedAt": "2019-03-24T15:46:09.000Z"
 }
Response - 400 - Deployment already in progress

Body
Copied!
Downloaded!
{
    "request": {
        "id": "e43g585f-cebf-42e1-b6d7-b95beeacd693",
        "url": "/aws/ec2/group/oesg-4ea3f65a/clusterRoll?spotinstAccountId=act-7461862f",
        "method": "POST",
        "timestamp": "2019-06-27T11:06:47.335Z"
    },
    "response": {
        "status": {
            "code": 400,
            "message": "Bad Request"
        },
        "errors": [
            {
                "code": "DEPLOYMENT_ALREADY_IN_PROGRESS",
                "message": "A group roll is currently running. Cannot start cluster roll until the group roll completes."
            }
        ],
        "count": 1
    }
}