as — Auto Scaling
as · 2018-04-19
DescribeScalingPolicies
POST
Query alarm trigger policies.
Wire call
Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /as/DescribeScalingPolicies 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: DescribeScalingPolicies' \
-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 |
|---|---|---|---|
| AutoScalingPolicyIds | string[] | — | Queries by one or more alarm policy IDs in the format of asp-i9vkg894. The maximum number of instances per request is 100. This parameter does not support specifying both `AutoScalingPolicyIds` 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 |
|---|---|---|
| ScalingPolicySet | ScalingPolicy[] | List of AS alarm trigger policy details. |
| TotalCount | integer | Number of eligible notifications. |
| 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": {
"ScalingPolicySet": …,
"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 · DescribeScalingPolicies
Read-only. Creates nothing.
Recorded example response
{
"TotalCount": 0,
"ScalingPolicySet": []
}