Tenant Cloud Storage Cloud Block Storage Snapshot APIs DescribeSnapshots

DescribeSnapshots

Last Updated At: 2026-08-03 00:04:14

1. Interface Description

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

This API (DescribeSnapshots) is used to query details of snapshots.

  • Filter can be performed by snapshot ID, and ID and type of the cloud disk that created the snapshot. 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 snapshot list for the current user is returned.

Default interface request rate limit: 20 times per second.

Interface update time: 2024-08-14 08:44:35.

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: DescribeSnapshots
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
SnapshotIds No No Array of String List of snapshot IDs to query. Parameters SnapshotIds and Filters cannot be specified at the same time.
Example: snap-j1ytqcd7
Filters No No Array of Filter Filter criteria. The parameters SnapshotIds and Filters cannot be specified at the same time. 
  • snapshot-id - Array of String - Required: No - (Filter criteria) Filter by snapshot ID in the format like snap-11112222. 
  • snapshot-name - Array of String - Required: No - (Filter criteria) Filter by snapshot name. 
  • snapshot-state - Array of String - Required: No - (Filter criteria) Filter by snapshot status. (NORMAL: normal 
    		•
    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: DESC
    		•
    OrderField No No String Field based on which the snapshot list is sorted. Value range:
  • CREATE_TIME: Sort by the creation time of the snapshot
    Snapshots are sorted by creation time by default.
    Example: CREATE_TIME
    		•
    InnerSearch No No String Fuzzy search parameter.
    Example: snap-j1ytqcd7

    3. Output Parameters

    Parameter name Type Description
    TotalCount Uint64 Number of snapshots.
    Example: 20
    SnapshotSet Array of Snapshot List of snapshots details.
    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.