Modifies the lifecycle of data that is backed up based on a backup schedule.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
dbs:ModifyStorageStrategy |
update |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| BackupPlanId |
string |
Yes |
The ID of the backup schedule. You can call the DescribeBackupPlanList operation to obtain the ID. |
dbsqdss5tmh**** |
| BackupRetentionPeriod |
integer |
Yes |
The number of days for which the backup data is retained. Valid values: 0 to 1825. Note
Default value: 730. |
730 |
| DuplicationInfrequentAccessPeriod |
integer |
Yes |
The number of days after which the storage class of the backup data is changed to Infrequent Access (IA). The value of this parameter must be smaller than the value of the DuplicationArchivePeriod parameter. For more information about the IA storage class, see Storage class overview. Note
Default value: 180. |
190 |
| DuplicationArchivePeriod |
integer |
Yes |
The number of days after which the storage class of the backup data is changed to Archive. The value of this parameter must be smaller than the value of the BackupRetentionPeriod parameter. For more information about the Archive storage class, see Storage class overview. Note
Default value: 365. |
366 |
| ClientToken |
string |
No |
The client token that is used to ensure the idempotence of the request. |
dbstest |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| HttpStatusCode |
integer |
The HTTP status code. |
200 |
| RequestId |
string |
The ID of the request. |
E995F91F-6F89-503B-9F7D-502F58FD**** |
| ErrCode |
string |
The error code. |
Param.NotFound |
| Success |
boolean |
Indicates whether the request is successful. Valid values:
|
true |
| ErrMessage |
string |
The error message. |
findValidDBSJob error |
| BackupPlanId |
string |
The ID of the backup schedule. |
dbsqdss5tmh**** |
| NeedPrecheck |
boolean |
Indicates whether a precheck is triggered. Valid values:
|
false |
Examples
Success response
JSON format
{
"HttpStatusCode": 200,
"RequestId": "E995F91F-6F89-503B-9F7D-502F58FD****",
"ErrCode": "Param.NotFound",
"Success": true,
"ErrMessage": "findValidDBSJob error",
"BackupPlanId": "dbsqdss5tmh****",
"NeedPrecheck": false
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 403 | Request.Forbidden | Have no Permissions |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.