All Products
Search
Document Center

Database Backup:ModifyBackupStrategy

Last Updated:Nov 09, 2022

Modifies the backup time of a backup schedule.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operateaccess levelResource typeconditional keywordAssociation operation
dbs:ModifyBackupStrategyRead
    All resources
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
BackupPlanIdstringYes

The ID of the backup schedule.

dbstooi01XXXX
BackupPeriodstringYes

The day of each week when the full backup task runs. Valid values:

  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday
Monday
BackupStartTimestringNo

The start time of the full backup task. Specify the time in the HH:mm format.

14:22
BackupStrategyTypestringNo

The backup method that you want to use for full backups. Valid values:

  • simple: scheduled backup. If you specify this value for the BackupStrategyType parameter, you must also specify the BackupPeriod and BackupStartTime parameters.
  • Manual: manual backup.
NoteDefault value: simple.
simple
BackupLogIntervalSecondsintegerNo

The interval at which you want to perform incremental log backups. Unit: seconds.

NoteThis parameter takes effect only when physical backups are performed.
1000
ClientTokenstringNo

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

ETnLKlblzczshOTUbOCzxxxxxxx

Response parameters

ParameterTypeDescriptionExample
object
HttpStatusCodeinteger

The HTTP status code.

200
RequestIdstring

The ID of the request.

D6E068C3-25BC-455A-85FE-45F0B22ECB1F
ErrCodestring

The error code.

Param.NotFound
Successboolean

Indicates whether the request is successful.

true
ErrMessagestring

The error message.

The specified parameter %s value is not valid.
BackupPlanIdstring

The ID of the backup schedule.

dbstooi01XXXX
NeedPrecheckboolean

Indicates whether a precheck is triggered. If the value of this parameter is true, you must start the backup schedule by calling the StartBackupPlan operation.

false

Example

Normal return example

JSONFormat

{
  "HttpStatusCode": 200,
  "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22ECB1F",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid. ",
  "BackupPlanId": "dbstooi01XXXX",
  "NeedPrecheck": true
}

Error codes

For a list of error codes, visit the API error center.