cbs · 2017-03-12

DescribeDisks

POST

Query the list of 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/DescribeDisks 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: DescribeDisks' \
  -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
DiskIds	string[]	—	Query by one or more cloud disk IDs, such as `disk-11112222`. For the format of this parameter, please see the ids.N section of the API Introduction. This parameter does not support specifying both `DiskIds` and `Filters`.
Filters	Filter[]	—	Filters. You cannot specify `DiskIds` and `Filters` at the same time. disk-usage - Array of String - Optional - Filters by cloud disk type. (SYSTEM_DISK: system disk \| DATA_DISK: data disk) disk-charge-type - Array of String - Optional - Filters by cloud disk billing method. (POSTPAID_BY_HOUR: pay-as-you-go) portable - Array of String- Optional - Filters by whether the cloud disk is elastic or …
Offset	integer	—	Offset. Default is 0. For more information on `Offset`, please see relevant sections in API Introduction.
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.
Order	string	—	Outputs the ordering of the cloud disk list. Value range: ASC: Ascending order DESC: Descending order.
OrderField	string	—	The field by which the cloud disk list is sorted. Value range: CREATE_TIME: sorted by the creation time of cloud disks DEADLINE: sorted by the expiration time of cloud disks By default, the cloud disk list is sorted by the creation time of cloud disks.
ReturnBindAutoSnapshotPolicy	boolean	—	Whether the ID of the periodic snapshot policy bound to the cloud disk needs to be returned in the cloud disk details. TRUE: return; FALSE: do not return.

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 cloud disks meeting the conditions.
DiskSet	Disk[]	List of cloud disk details.
RequestId	string	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

Success

{
  "Response": {
    "TotalCount": …,
    "DiskSet": …,
    "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 · DescribeDisks

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

Read-only. Creates nothing.

Recorded example response — captured 2026-09-16

{
  "Response": {
    "TotalCount": 1,
    "RequestId": "0b54163a-0e40-534e-8fb3-7fc334706230",
    "DiskSet": [
      {
        "BurstPerformance": false,
        "DeleteWithInstance": true,
        "RenewFlag": "",
        "PlatformProjectId": "",
        "EncryptAlgorithm": null,
        "LatestOperationState": "",
        "DiskType": "CLOUD_PREMIUM",
        "DiskBackupQuota": 0,
        "DiskState": "ATTACHED",
        "SnapshotCount": 0,
        "DiskBackupCount": 0,
        "AutoRenewFlagError": false,
        "Rollbacking": false,
        "InstanceIdList": [
          "ins-6l9ee4b2"
        ],
        "Encrypt": false,
        "Tags": [],
        "DiskName": "example-instance_SYSTEM_DISK",
        "BackupDisk": false,
        "DeleteSnapshot": 0,
        "InstanceId": "ins-6l9ee4b2",
        "DifferDaysOfDeadline": null,
        "ThroughputPerformance": 0,
        "Migrating": false,
        "InstanceType": "CVM",
        "DiskId": "disk-95nee2g8",
        "LastAttachInsId": "ins-6l9ee4b2",
        "SnapshotSize": 0,
        "Placement": {
          "CageId": "",
          "DedicatedClusterId": null,
          "Zone": "clz-1",
          "ProjectName": "默认项目",
          "ProjectId": 0,
          "CdcName": "",
          "CdcId": "",
          "ClusterGroupId": null
        },
        "IsReturnable": null,
        "DeadlineTime": "",
        "Attached": true,
        "ReturnFailCode": null,
        "DiskSize": 50,
        "DiskStoragePoolGroup": null,
        "MigratePercent": 0,
        "DiskUsage": "SYSTEM_DISK",
        "ErrorPrompt": "",
        "Portable": false,
        "DiskChargeType": "POSTPAID_BY_HOUR",
        "SnapshotAbility": true,
        "DeadlineError": false,
        "LatestOperationRequestId": "",
        "RollbackPercent": 100,
        "AutoSnapshotPolicyIds": null,
        "LatestOperation": "",
        "Shareable": false,
        "CreateTime": "2026-09-16 19:30:13"
      }
    ]
  }
}

Behaviour

DeleteWithInstance defaults to true for a system disk, which is therefore deleted with its instance.