cbs · 2017-03-12

DescribeAutoSnapshotPolicies

POST

Query scheduled snapshot policies.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cbs/DescribeAutoSnapshotPolicies 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://cbs.api3.convergecloud.com/ \
  -H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/cbs/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'Host: cbs.api3.convergecloud.com' \
  -H 'X-TC-Action: DescribeAutoSnapshotPolicies' \
  -H 'X-TC-Version: 2017-03-12' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{"Limit":20,"Offset":0}'

Request parameters

Field	Type	Required	Description
AutoSnapshotPolicyIds	string[]	—	List of scheduled snapshot policy IDs to be queried. The parameter does not support specifying both `SnapshotIds` and `Filters`.
Filters	Filter[]	—	Filter conditions. Specification of both the `AutoSnapshotPolicyIds` and `Filters` parameters is not supported. auto-snapshot-policy-id - Array of String - Required or not: No - (Filter condition) Filters according to the scheduled snapshot policy ID. The format of the scheduled snapshot policy ID is as follows: `asp-11112222`. auto-snapshot-policy-state - Array of String - Required or not: No …
Limit	integer	—	Number of results to be returned. Default is 20. Maximum is 100. For more information on `Limit`, please see relevant sections in API Introduction.
Offset	integer	—	Offset. Default is 0. For more information on `Offset`, please see relevant sections in API Introduction.
Order	string	—	Outputs the ordering of the scheduled snapshot lists. Value range: ASC: Ascending order DESC: Descending order.
OrderField	string	—	The sorting filter applied to the scheduled snapshot list. Value range: <Sort by creation time of scheduled snapshot. By default, this is sorted by creation time.

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
TotalCount	integer	The quantity of valid scheduled snapshot policies.
AutoSnapshotPolicySet	AutoSnapshotPolicy[]	List of scheduled snapshot policies.
RequestId	string	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

Success

{
  "Response": {
    "TotalCount": …,
    "AutoSnapshotPolicySet": …,
    "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/cbs.

SecretIdSecretKey

Request bodyvalid JSONPOST cbs.api3.convergecloud.com · DescribeAutoSnapshotPolicies

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

Read-only. Creates nothing.

Recorded example response

{
  "AutoSnapshotPolicySet": [],
  "TotalCount": 0,
  "RequestId": "c2722b37-1fe8-db42-8bef-1dd90cd363f4"
}