Tenant Cloud Storage Cloud Block Storage Cloud Disk APIs DescribeDisks

DescribeDisks

Last Updated At: 2026-08-02 00:04:24

1. Interface Description

Interface request domain name: cbs.api3.convergecloud.com.

This API (DescribeDisks) is used to query the cloud disk list.

  • You can query details of the cloud disk by its ID, type, or status. These conditions are in an AND relationship. For detailed filter information, refer to the Filter.
  • If parameters are empty, a certain number (specified by Limit, default is 20) of the cloud disk list for the current user is returned.

Default interface request rate limit: 20 times per second.

Interface update time: 2024-08-14 08:50:33.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: DescribeDisks
Version Yes No String Public parameter, The value of this interface: 2017-03-12
Region No No String Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
DiskIds No No Array of String Query by one or more cloud disk IDs in the format like disk-11112222. The parameters DiskIds and Filters cannot be specified at the same time.
Example: ["disk-6rag8jef"]
Filters No No Array of Filter Filter criteria. The parameters DiskIds and Filters cannot be specified at the same time. 
  • disk-usage - Array of String - Required: No - (Filter criteria) Filter by cloud disk type. (SYSTEM_DISK: system disk 
    		•
    Offset No No Uint64 Offset. The default value is 0.
    Example: 0
    Limit No No Uint64 Number of returned values. The default value is 20, and the maximum value is 100.
    Example: 20
    Order No No String Output cloud disk list sorting order. Value range:
  • ASC: ascending
  • DESC: descending.
    Example: ASC
    		•
    OrderField No No String Field based on which cloud disk list is sorted. Value range:
  • CREATE_TIME: Sort by the cloud disk creation time
  • DEADLINE: Sort by the cloud disk expiration time
    Cloud disks are sorted by the creation time by default.
    Example: CREATE_TIME
    		•
    ReturnBindAutoSnapshotPolicy No No Bool It indicates whether the cloud disk details need to return the ID of the regular snapshot policy to which the cloud disk is bound. TRUE indicates to return, and FALSE indicates not to return.
    Example: FALSE
    InnerSearch No No String Used to support search box search, internal parameters.
    Example: disk-6rag8jef

    3. Output Parameters

    Parameter name Type Description
    TotalCount Uint64 Number of qualified cloud disks.
    Example: 1
    DiskSet Array of Disk Detailed information list of cloud disks.
    Example:View
    RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

    4. Error Code

    The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

    Error Code Description
    InvalidParameterValue Invalid parameter value. The format of the parameter value is incorrect or the parameter value is not supported.
    MissingParameter Missing parameter. The request does not include the mandatory parameter.
    InvalidFilter The specified filter is not supported.