You can call this operation to modify the time to live (TTL) of data stored in a backup plan.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ModifyStorageStrategy

The operation that you want to perform. Valid values: ModifyStorageStrategy

BackupPlanId String Yes dbstooi01xxxx

The ID of the backup plan. You can call DescribeBackupPlanList query.

BackupRetentionPeriod Integer Yes 730

The retention period of backup data. Unit: Days. Valid values: 0 to 1825.

Note Default value: 730 days.
DuplicationArchivePeriod Integer Yes 365

Convert the storage period to archive. The value must be earlier than the retention period of backup data. This parameter is BackupRetentionPeriod. For more information about archive storage, see storage types.

Note Default value: 365 (days).
DuplicationInfrequentAccessPeriod Integer Yes 180

The storage time for converting to low-frequency access needs to be smaller than the archive cold storage time (DuplicationArchivePeriod parameter). For more information about IA storage, see storage types.

Note Default value: 180 (days).
RegionId String No cn-hangzhou

The region ID of the resource. You can call DescribeRegions query.

ClientToken String No dbs

A string.

Response parameters

Parameter Type Example Description
BackupPlanId String dbstooi01xxxx

The ID of the backup plan.

ErrCode String Param.NotFound

The error code.

ErrMessage String findValidDBSJob error

The returned message.

HttpStatusCode Integer 200

The HTTP status code.

NeedPrecheck Boolean false

Whether the modification will trigger a PreCheck. Valid values:

  • true: The PreCheck has been triggered. You must manually call the operation. StartBackupPlan to start the backup plan.
  • false: does not trigger the PreCheck.
RequestId String D6E068C3-25BC-455A-85FE-45F0B22ECB1F

The ID of the request.

Success Boolean true

Indicates whether the execution was successful. Valid values:

  • true: Succeeded
  • false: execution failed

Examples

Sample requests

http(s)://dbs-api.cn-hangzhou.aliyuncs.com/? Action=ModifyStorageStrategy
&BackupPlanId=dbstooi01xxxx
&BackupRetentionPeriod=730
&DuplicationArchivePeriod=365
&DuplicationInfrequentAccessPeriod=180
&<Common request parameters>

Sample success responses

XML format

<RequestId>D6E068C3-25BC-455A-85FE-45F0B22ECB1F</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<BackupPlanId>dbstooi01xxxx</BackupPlanId>
<NeedPrecheck>false</NeedPrecheck>
<ErrMessage>findValidDBSJob error</ErrMessage>
<Success>true</Success>
<ErrCode>Param.NotFound</ErrCode>

JSON format

{"RequestId":"D6E068C3-25BC-455A-85FE-45F0B22ECB1F","HttpStatusCode":"200","BackupPlanId":"dbstooi01xxxx","NeedPrecheck":"false","ErrMessage":"findValidDBSJob error","Success":"true","ErrCode":"Param.NotFound"}

Error codes

For a list of error codes, visit the API Error Center.