cbs — Cloud Block Storage
cbs · 2017-03-12
DescribeDiskConfigQuota
POST
Query the cloud disk quota.
Wire call
Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cbs/DescribeDiskConfigQuota 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: DescribeDiskConfigQuota' \
-H 'X-TC-Version: 2017-03-12' \
-H 'X-TC-Timestamp: <unix-seconds>' \
-H 'X-TC-Region: luzon' \
-d '{"InquiryType":"<InquiryType>"}'Request parameters
| Field | Type | Required | Description |
|---|---|---|---|
| InquiryType | string | Yes | Inquiry type. Value range: INQUIRY_CBS_CONFIG: query the configuration list of cloud disks INQUIRY_CVM_CONFIG: query the configuration list of cloud disks and instances. |
| Zones | string[] | No | Query configuration under one or more availability zone. |
| DiskChargeType | string | No | Billing mode. Value range: POSTPAID_BY_HOUR: postpaid. |
| DiskTypes | string[] | No | Cloud disk media type. Valid values: CLOUD_BASIC: HDD cloud disk CLOUD_PREMIUM: Premium Cloud Storage CLOUD_SSD: SSD CLOUD_HSSD: Enhanced SSD |
| DiskUsage | string | No | The system disk or data disk. Value range: SYSTEM_DISK: System disk DATA_DISK: Data disk. |
| InstanceFamilies | string[] | No | Filter by the instance model series, such as S1, I1 and M1. For more information, please see Instance Types |
| CPU | integer | No | Instance CPU cores. |
| Memory | integer | No | Instance memory size. |
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 |
|---|---|---|
| DiskConfigSet | DiskConfig[] | List of cloud disk configurations. |
| RequestId | string | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
Success
{
"Response": {
"DiskConfigSet": …,
"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 · DescribeDiskConfigQuota
Read-only. Creates nothing.