All Products
Search
Document Center

Database Backup:ModifyStorageStrategy

Last Updated:Nov 14, 2024

Modifies the lifecycle of data in a backup schedule.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dbs:ModifyStorageStrategyupdate
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
BackupPlanIdstringYes

The ID of the backup schedule. You can call the DescribeBackupPlanList operation to obtain the ID of the backup schedule.

dbsqdss5tmh****
BackupRetentionPeriodintegerYes

The number of days for which the backup data is retained. Valid values: 0 to 1825.

Note Default value: 730.
730
DuplicationInfrequentAccessPeriodintegerYes

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
DuplicationArchivePeriodintegerYes

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
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request.

dbstest

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

HttpStatusCodeinteger

The HTTP status code.

200
RequestIdstring

The ID of the request.

E995F91F-6F89-503B-9F7D-502F58FD****
ErrCodestring

The error code.

Param.NotFound
Successboolean

Indicates whether the request is successful. Valid values:

  • true: The request is successful.
  • false: The request fails.
true
ErrMessagestring

The error message.

findValidDBSJob error
BackupPlanIdstring

The ID of the backup schedule.

dbsqdss5tmh****
NeedPrecheckboolean

Indicates whether a precheck is triggered. Valid values:

  • true: A precheck is triggered. You must manually call the StartBackupPlan operation to start the backup schedule.
  • false: No precheck is triggered.
false

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "RequestId": "E995F91F-6F89-503B-9F7D-502F58FD****",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "findValidDBSJob error",
  "BackupPlanId": "dbsqdss5tmh****",
  "NeedPrecheck": false
}

Error codes

HTTP status codeError codeError message
403Request.ForbiddenHave no Permissions

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history