Last updated: 2020-06-19 10:58:36

    1. API Description

    Domain name for API request:

    This API (BindAutoSnapshotPolicy) is used to bind the cloud disk to the specified scheduled snapshot policy.

    • When a cloud disk that is bound to a scheduled snapshot policy is in the unused state (that is, an elastic cloud disk has not been mounted or the server of an inelastic disk is powered off) scheduled snapshots are not created.

    A maximum of 20 requests can be initiated per second for this API.

    Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example:

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common parameter. The value used for this API: BindAutoSnapshotPolicy.
    Version Yes String Common parameter. The value used for this API: 2017-03-12.
    Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
    AutoSnapshotPolicyId Yes String ID of scheduled snapshot policy to be bound.
    DiskIds.N Yes Array of String List of cloud disk IDs to be bound. Maximum of 80 cloud disks can be bound per request.

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Binding Scheduled Snapshot Policy for Single Disk

    Input Example
    &<common request parameters>

    Output Example

      "Response": {
        "RequestId": "bda8bd1a-754d-d71b-8300-5a1fa45c237f"

    5. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.


    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    InvalidAutoSnapshotPolicyId.NotFound AutoSnapshotPolicyId entered does not exist.
    InvalidDisk.AlreadyBound Cloud disk is already bound to scheduled snapshot policy.
    InvalidDisk.NotSupported Indicates that the operation is not supported for the cloud disk.
    InvalidDiskId.NotFound The ‘DiskId’ entered does not exist.
    InvalidParameterValue Invalid parameter value. Parameter value format error or parameter value not supported.
    InvalidParameterValue.BindDiskLimitExceeded Number of labels bound to cloud disk exceeds the limit.
    InvalidParameterValue.LimitExceeded Number of parameter values exceeds the limit.
    MissingParameter Missing parameter. Request does not include the required parameter.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback