Tenant Cloud Storage Cloud Block Storage Snapshot APIs DescribeCopyAutoSnapshotPolicy

DescribeCopyAutoSnapshotPolicy

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

1. Interface Description

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

This API is used to query the details of cross-account automatic snapshot policy replication.

Default interface request rate limit: 20 times per second.

Interface update time: 2025-08-28 17:44:30.

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: DescribeCopyAutoSnapshotPolicy
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
OrderField No No String Field based on which the regular snapshot list is sorted. CREATETIME: Sort by the creation time of the regular snapshot. Snapshots are sorted the by creation time by default.
Example: CREATE_TIME
CopyAction Yes No String Automatic snapshot policy replication action. REMOTE: Backup to another account; LOCAL: Backup to my account
Example: REMOTE
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-ljylgbyo"]
Limit No No Uint64 Number of returned values. The default value is 20, and the maximum value is 100.
Example: 20
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 
    		•
    Offset No No Uint64 Offset. The default value is 0.
    Example: 0
    Order No No String Output order of the regular snapshot list. ASC indicates ascending and DESC indicates descending.
    Example: ASC

    3. Output Parameters

    Parameter name Type Description
    TotalCount Uint64 Number of Active Regular Snapshot Policies
    Example: 10
    CopyAutoSnapshotPolicySet Array of AutoSnapshotPolicy List of Regular Snapshot Policies for Cross-account Replication
    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.
    ResourceBusy The resource is busy. Try again later.
    InvalidParameter Parameter error