Converge Studios
as — Auto Scaling
as · 2018-04-19

DescribeAutoScalingInstances

POST

Query the information of instances associated with AS.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /as/DescribeAutoScalingInstances 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: DescribeAutoScalingInstances' \
  -H 'X-TC-Version: 2018-04-19' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{"Offset":0,"Limit":20}'

Request parameters

FieldTypeRequiredDescription
InstanceIdsstring[]—IDs of the CVM instances to query. the instance ID list has a length limit of 100. `InstanceIds` and `Filters` cannot be specified simultaneously.
FiltersFilter[]—Filter criteria
Offsetinteger—Offset. Default value: 0. For more information on `Offset`, see the relevant section in the API overview.
Limitinteger—The number of returned results. Default value: `20`. Maximum value: `100`. For more information on `Limit`, see the relevant sections in API Introduction.

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.

FieldTypeDescription
AutoScalingInstanceSetInstance[]List of instance details.
TotalCountintegerNumber of eligible instances.
RequestIdstringThe 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": {
    "AutoScalingInstanceSet": …,
    "TotalCount": …,
    "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.
Request bodyvalid JSONPOST as.api3.convergecloud.com · DescribeAutoScalingInstances
Read-only. Creates nothing.
Recorded example response
{
  "TotalCount": 0,
  "AutoScalingInstanceSet": []
}