Converge Studios
cbs — Cloud Block Storage
cbs · 2017-03-12

DescribeInstancesDiskNum

POST

Query the number of cloud disks mounted in the instance.

Wire call

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

Request parameters

FieldTypeRequiredDescription
InstanceIdsstring[]YesID of the CVM instance can be queried via the API DescribeInstances.

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
AttachDetailAttachDetail[]The quantity of mounted and mountable elastic cloud disks for each cloud virtual machine
RequestIdstringThe unique request ID, which is returned for each request. RequestId is required for locating a problem.
Success
{
  "Response": {
    "AttachDetail": …,
    "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.
Request bodyvalid JSONPOST cbs.api3.convergecloud.com · DescribeInstancesDiskNum
Read-only. Creates nothing.
Recorded example response
{
  "AttachDetail": [
    {
      "InstanceId": "ins-zzzz9999",
      "AttachedDiskCount": 0,
      "MaxAttachCount": 20
    }
  ],
  "RequestId": "b4474d69-1a3d-d09f-ae38-aa5ba6e9931a"
}