cbs — Cloud Block Storage
cbs · 2017-03-12
InquiryPriceCreateDisks
POST
Query the price of creating cloud disks.
Wire call
Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cbs/InquiryPriceCreateDisks 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: InquiryPriceCreateDisks' \
-H 'X-TC-Version: 2017-03-12' \
-H 'X-TC-Timestamp: <unix-seconds>' \
-H 'X-TC-Region: luzon' \
-d '{"DiskChargeType":"<DiskChargeType>","DiskType":"<DiskType>","DiskSize":1}'Request parameters
| Field | Type | Required | Description |
|---|---|---|---|
| DiskChargeType | string | Yes | Cloud disk billing mode. |
| DiskType | string | Yes | Hard disk media type. valid values: CLOUD_PREMIUM: high-performance CLOUD block storage CLOUD_SSD: SSD CLOUD disk CLOUD_HSSD: enhanced SSD CLOUD disk CLOUD_TSSD: ultra-fast SSD cbs. |
| DiskSize | integer | Yes | Specifies the disk capacity in GiB. for the cloud disk size range, please refer to the product type of cloud block storage. |
| ProjectId | integer | No | cloud disk project ID. obtain this parameter by calling the projectId field in the return value of DescribeProject. default to the default project. |
| DiskCount | integer | No | Specifies the number of cloud block storage (cbs) disks to purchase. defaults to 1 if left blank. |
| ThroughputPerformance | integer | No | Specifies the additional performance value of the CBS disk in MiB/s. extra performance is only supported for enhanced SSD (CLOUD_HSSD) and ultra-fast SSD (CLOUD_TSSD) CBS disks exceeding 460GiB in size. |
| DiskChargePrepaid | DiskChargePrepaid | No | Prepaid mode, that is, the settings for the monthly subscription-related parameters. through this parameter, you can specify the purchase duration of the monthly subscribed cloud disk, whether to enable auto-renewal, and other attributes. this parameter is required for creating a prepaid cloud disk, but no need to specify it when creating an hourly postpaid cloud disk. |
| DiskBackupQuota | integer | No | Specifies the cloud disk backup point quota. |
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 |
|---|---|---|
| DiskPrice | object | Describes the price of newly purchased cloud disks. |
| 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": {
"DiskPrice": …,
"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 · InquiryPriceCreateDisks
Read-only. Creates nothing.