Tenant Cloud Storage Cloud Block Storage Snapshot APIs DescribeSnapshotGroups

DescribeSnapshotGroups

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

1. Interface Description

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

This API is used to query the snapshot group list, returning snapshot groups that are in the states of Normal, Creating, or Rolling Back.

Default interface request rate limit: 20 times per second.

Interface update time: 2025-08-28 18:03:43.

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: DescribeSnapshotGroups
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
Filters No No Array of Filter Filter criteria.
  • snapshot-group-id - Array of String - Required: No - (Filter criteria) Filter by snapshot group ID
  • snapshot-group-state - Array of String - Required: No - (Filter criteria) Filter by snapshot group state. (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 Results sorting order. DESC indicates descending, and ASC indicates ascending.
    Example: ASC
    InnerSearch No No String Fuzzy search parameter.
    Example: snap-j1ytqcd7

    3. Output Parameters

    Parameter name Type Description
    TotalCount Uint64 Total Number of Qualified Items
    Example: 100
    SnapshotGroupSet Array of SnapshotGroup Details of Snapshot Group List
    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
    InvalidParameter Parameter error