cbs · 2017-03-12

GetSnapOverview

POST

Get snapshot overview information.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cbs/GetSnapOverview 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: GetSnapOverview' \
  -H 'X-TC-Version: 2017-03-12' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{}'

Request parameters

This action takes no parameters.

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
TotalSize	number	The total snapshot size of the user
RealTradeSize	number	The total billed snapshot size of the user
FreeQuota	number	Free tier of snapshot
TotalNums	integer	Total number of snapshots
RequestId	string	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

Success

{
  "Response": {
    "TotalSize": …,
    "RealTradeSize": …,
    "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 · GetSnapOverview

{}

Read-only. Creates nothing.

Recorded example response

{
  "TotalNums": 0,
  "TotalSize": 0,
  "FreeQuota": 0,
  "RealTradeSize": 0,
  "RequestId": "f93c4721-be16-578b-aeb4-9948b0b62fb8"
}