1. Interface Description
Interface request domain name: cbs.api3.convergecloud.com.
This API (BindAutoSnapshotPolicy) is used to bind a cloud disk to a specified regular snapshot policy.
- A maximum of 10 regular snapshot policies can be created in each region, and each regular snapshot policy can be bound to up to 80 cloud disks.
- Regular snapshots will not be created for cloud disks bound to a regular snapshot policy that is in an unused state (that is, the elastic cloud disk is not mounted or the host of a non-elastic cloud disk is shut down).
Default interface request rate limit: 20 times per second.
Interface update time: 2025-03-29 00:39:19.
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: BindAutoSnapshotPolicy |
| 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 |
| AutoSnapshotPolicyId | Yes | No | String | Regular snapshot policy ID to be bound. Example: asp-6xtxct37 |
| DiskIds | No | No | Array of String | ID List of cloud disks to be bound. Up to 80 cloud disks can be bound in a single request. Example: ["disk-7q2iy7gp"] |
| InstanceIds | No | No | Array of String | List of instances to be bound. Up to 100 instances can be bound at a time. Example: ["ins-locaa0iu"] |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| 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 |
|---|---|
| InvalidDisk.NotSupported | The cloud disk does not support this operation. |
| MissingParameter | Missing parameter. The request does not include the mandatory parameter. |
| InvalidParameterValue | Invalid parameter value. The format of the parameter value is incorrect or the parameter value is not supported. |
| InvalidParameterValue.LimitExceeded | The parameter value is out of range |
| InvalidAutoSnapshotPolicyId.NotFound | The input AutoSnapshotPolicyId does not exist. |