Tenant Cloud Storage Cloud Block Storage Snapshot APIs DescribeAutoSnapshotPolicies

DescribeAutoSnapshotPolicies

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

1. Interface Description

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

This API (DescribeAutoSnapshotPolicies) is used to query regular snapshot policies.

  • You can query the details of regular snapshot policies by their ID, name, or status. Different conditions are in an AND relationship. For more details, refer to the Filter.
  • If the parameter is empty, a certain number (specified by Limit, default is 20) of regular snapshot policies for the current user is returned.

Default interface request rate limit: 20 times per second.

Interface update time: 2024-08-16 06:42:32.

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: DescribeAutoSnapshotPolicies
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
AutoSnapshotPolicyIds No No Array of String List of regular snapshot policy IDs to query. Parameters AutoSnapshotPolicyIds and Filters cannot be specified at the same time.
Example: ["asp-c9m1berf"]
Filters No No Array of Filter Filter criteria. Parameters AutoSnapshotPolicyIds and Filters cannot be specified at the same time.
  • auto-snapshot-policy-id - Array of String - Required: No - (Filter criteria) Filter by regular snapshot policy ID. The regular snapshot policy ID is in the format of asp-11112222.
  • auto-snapshot-policy-state - Array of String - Required: No - (Filter criteria) Filter by the status of the regular snapshot policy. The regular snapshot policy ID is in the format of asp-11112222. (NORMAL: Normal 
    		•
    Limit No No Uint64 Number of returned values. The default value is 20, and the maximum value is 100. For more information about Limit, refer to the relevant sections in API [Overview].
    Example: 20
    Offset No No Uint64 Offset. The default value is 0. For more information about Offset, refer to the relevant sections in the API [Overview].
    Example: 0
    Order No No String Output order of the regular snapshot list. Value range:
  • ASC: ascending
  • DESC: descending.
    Example: ASC
    		•
    OrderField No No String Field based on which the regular snapshot list is sorted. Value range:
  • CREATETIME: Sort by the creation time of the regular snapshot
    Snapshots are sorted by the creation time by default.
    Example: CREATETIME
    		•
    TryCreateDefaultAutoSnapshotPolicy No No Bool When this parameter is input, the system will try to create a default regular snapshot policy. If the user already has a regular snapshot policy, no policy is created.
    Example: true
    InnerSearch No No String Fuzzy Search Parameter
    Example: asp-asgag224

    3. Output Parameters

    Parameter name Type Description
    TotalCount Uint64 Number of valid regular snapshot policies.
    Example: 0
    AutoSnapshotPolicySet Array of AutoSnapshotPolicy List of regular snapshot policies.
    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
    MissingParameter Missing parameter. The request does not include the mandatory parameter.
    InvalidFilter The specified filter is not supported.
    InvalidParameterValue Invalid parameter value. The format of the parameter value is incorrect or the parameter value is not supported.