as · 2018-04-19

SetInstancesProtection

POST

Enable scale-in protection for an instance.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /as/SetInstancesProtection path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.

curl

curl -sS https://as.api3.convergecloud.com/ \
  -H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/as/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'Host: as.api3.convergecloud.com' \
  -H 'X-TC-Action: SetInstancesProtection' \
  -H 'X-TC-Version: 2018-04-19' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{"AutoScalingGroupId":"<AutoScalingGroupId>","InstanceIds":["<InstanceId>"],"ProtectedFromScaleIn":"<ProtectedFromScaleIn>"}'

Request parameters

Field	Type	Required	Description
AutoScalingGroupId	string	Yes	Auto scaling group ID. obtain available scaling group ids in the following ways:.
InstanceIds	string[]	Yes	Instance ID. you can obtain available instance ID in the following ways:.
ProtectedFromScaleIn	boolean	Yes	Whether to enable scale-in protection for this instance

Response

Fields are returned inside the Response envelope. Converge Cloud answers HTTP 200 for errors as well as successes, so read Response.Error rather than the status code — and test for the presence of that object, because Code is occasionally the empty string.

Field	Type	Description
RequestId	string	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

Success

{
  "Response": {
    // action-specific fields,
    "RequestId": "…"
  }
}

Error

{
  "Response": {
    "Error": { "Code": "…", "Message": "…" },
    "RequestId": "…"
  }
}

Try it

CredentialThe key never leaves this tab — it signs the request here. The signed request goes to /api-relay/as.

SecretIdSecretKey

Request bodyvalid JSONPOST as.api3.convergecloud.com · SetInstancesProtection

{
  "AutoScalingGroupId": "<AutoScalingGroupId>",
  "InstanceIds": [
    "<InstanceId>"
  ],
  "ProtectedFromScaleIn": "<ProtectedFromScaleIn>"
}

This action changes resources in my own account and may create a charge. I understand.

What failure looks like

Example error responses for this action. Match on Code.

Recorded error 1

{
  "Response": {
    "Error": {
      "Code": "ResourceNotFound.AutoScalingGroupNotFound",
      "Message": "The specified auto scaling group `asg-00000000` is not found."
    },
    "RequestId": "09831cbf-2c85-a1e4-a48c-a522d6be33c6"
  }
}