tencent cloud



Last updated: 2023-06-21 15:01:15

1. API Description

Domain name for API request: cbs.tencentcloudapi.com.

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

  • For the scheduled snapshot policy limit of each region, see Scheduled Snapshots.
  • 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.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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 Params. The value used for this API: BindAutoSnapshotPolicy.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
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 a scheduled snapshot policy to a single cloud disk

This example shows you how to bind a scheduled snapshot policy to a single cloud disk.

Input Example

&<Common request parameters>

Output Example

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

5. Developer Resources


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.
InvalidParameterValue.BindDiskLimitExceeded Number of labels bound to cloud disk exceeds the limit.
InvalidParameterValue.LimitExceeded Number of parameter values exceeds the limit.
MissingParameter Missing parameter.
ResourceNotFound.NotFound The resource is not found.
ResourceUnavailable.NotSupported The resource does not support this operation.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support