腾讯云云硬盘快照正式商业化计费公告
腾讯云云硬盘快照跨地域复制功能正式商业化计费公告
Domain name for API request: cbs.tencentcloudapi.com.
This API (CreateAutoSnapshotPolicy) is used to create a scheduled snapshot policy.
A maximum of 20 requests can be initiated per second for this API.
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: CreateAutoSnapshotPolicy. |
| 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. |
| Policy.N | Yes | Array of Policy | The policy for executing the scheduled snapshot. |
| AutoSnapshotPolicyName | No | String | The name of the scheduled snapshot policy to be created. If it is left empty, the default is 'Not named'. The maximum length cannot exceed 60 bytes. |
| IsActivated | No | Boolean | Whether or not the scheduled snapshot policy is activated. FALSE: Not activated. TRUE: Activated. The default value is TRUE. |
| IsPermanent | No | Boolean | Whether the snapshot created by this scheduled snapshot policy is retained permanently. FALSE: Not retained permanently. TRUE: Retained permanently. The default value is FALSE. |
| RetentionDays | No | Integer | The number of days that a snapshot created by this scheduled snapshot policy is retained. The default value is 7. If this parameter is specified, the IsPermanent input parameter can not be TRUE, otherwise a conflict will occur. |
| DryRun | No | Boolean | Whether to create an execution policy for the scheduled snapshot. TRUE: Only the time of the initial backup needs to be obtained, and no scheduled snapshot policy is actually created. FALSE: Create. The default value is FALSE. |
| Parameter Name | Type | Description |
|---|---|---|
| AutoSnapshotPolicyId | String | The ID of the newly created scheduled snapshot policy. |
| NextTriggerTime | String | The time that initial backup will start. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to create and bind a scheduled snapshot policy to a cloud disk, for which a snapshot will be created at 00:00 every Friday.
POST / HTTP/1.1
Host: cbs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAutoSnapshotPolicy
<Common request parameters>
{
"AutoSnapshotPolicyName": "backup_data_friday",
"Policy": [
{
"DayOfWeek": [
4
],
"Hour": [
0
]
}
]
}
{
"Response": {
"AutoSnapshotPolicyId": "asp-1lebc9r3",
"NextTriggerTime": "2018-08-08 16:00:00",
"RequestId": "88d95732-c4e9-bd97-4a23-5a1f978d3b72"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InvalidAccount.InsufficientBalance | Insufficient account balance |
| InvalidParameterValue | Invalid parameter value. |
| InvalidParameterValue.LimitExceeded | Number of parameter values exceeds the limit. |
| LimitExceeded.AutoSnapshotPolicyOutOfQuota | The number of scheduled snapshot policies has reached the upper limit. |
| MissingParameter | Missing parameter. |
文档反馈