as · 2018-04-19

DescribeAutoScalingGroups

POST

Query the information of auto scaling groups.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /as/DescribeAutoScalingGroups 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: DescribeAutoScalingGroups' \
  -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

Field	Type	Required	Description
AutoScalingGroupIds	string[]	—	Queries by one or more auto scaling group IDs in the format of `asg-nkdwoui0`. The maximum quantity per request is 100. This parameter does not support specifying both `AutoScalingGroupIds` and `Filters` at the same time.
Filters	Filter[]	—	Filter criteria
Limit	integer	—	Number of returned results. Default value: 20. Maximum value: 100. For more information on `Limit`, see the relevant section in the API overview.
Offset	integer	—	Offset. Default value: 0. For more information on `Offset`, see the relevant section in the API overview.

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
AutoScalingGroupSet	AutoScalingGroup[]	List of auto scaling group details.
TotalCount	integer	Number of eligible auto scaling groups.
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": {
    "AutoScalingGroupSet": …,
    "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.

SecretIdSecretKey

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

{
  "Offset": 0,
  "Limit": 20
}

Read-only. Creates nothing.

Recorded example response — captured 2026-09-16

{
  "Response": {
    "AutoScalingGroupSet": [],
    "TotalCount": 0,
    "RequestId": "cb6760e1-ce7c-254b-79fe-d5beaf95e6f1"
  }
}