Domain name for API request: cbs.tencentcloudapi.com.
This API (ModifyAutoSnapshotPolicyAttribute) is used to modify the attributes of an automatic 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: ModifyAutoSnapshotPolicyAttribute. |
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 | Scheduled snapshot policy ID. |
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. |
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. |
Policy.N | No | Array of Policy | The policy for executing the scheduled snapshot. |
RetentionDays | No | Integer | Number of days to retain the snapshots created according to this scheduled snapshot policy. If this parameter is specified, IsPermanent cannot be specified as TRUE ; otherwise, they will conflict with each other. |
Parameter Name | Type | Description |
---|---|---|
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 rename a scheduled snapshot policy to data_disk_auto_snapshot
and set the IsPermanent
parameter to TRUE
to permanently retain the snapshots created according to the scheduled snapshot policy.
POST / HTTP/1.1
Host: cbs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAutoSnapshotPolicyAttribute
<Common request parameters>
{
"AutoSnapshotPolicyId": "asp-nqu08k2l",
"AutoSnapshotPolicyName": "data_disk_auto_snapshot",
"IsPermanent": "TRUE"
}
{
"Response": {
"RequestId": "384c1fa8-6973-9623-b6bf-5a1fa9a7ad88"
}
}
This example shows you how to enable automatic snapshot policies.
POST / HTTP/1.1
Host: cbs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAutoSnapshotPolicyAttribute
<Common request parameters>
{
"AutoSnapshotPolicyId": "asp-01928374",
"IsActivated": "true"
}
{
"Response": {
"RequestId": "88a4815c-4a09-4948-b0c9-fa6fdefe8e4a"
}
}
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 |
InvalidAutoSnapshotPolicyId.NotFound | AutoSnapshotPolicyId entered does not exist. |
InvalidParameter | Incorrect parameter. |
MissingParameter | Missing parameter. |
UnsupportedOperation.StateError | The resource does not support this operation in this status. |
Was this page helpful?