DocsICP FilingConsole
Documentation

ModifyBackupStrategy

Updated at:
Copy as MD
Product
My Favorites

Modifies the backup time of a backup plan.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dbs:ModifyBackupStrategy

update

*BackupPlan

acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}

 None None

Request parameters

Parameter

Type

Required

Description

Example
BackupPlanId

string

Yes

The ID of the backup plan.

dbstooi01XXXX
BackupPeriod

string

Yes

The full backup cycle. Valid values:

  • Monday: Monday

  • Tuesday: Tuesday

  • Wednesday: Wednesday

  • Thursday: Thursday

  • Friday: Friday

  • Saturday: Saturday

  • Sunday: Sunday

Note

You must specify at least two days of the week for BackupPeriod and separate the days with commas (,).

Monday,Tuesday,Wednesday
BackupStartTime

string

No

The start time of the full backup. Format: HH:mm.

Note

This parameter is required.

14:22
BackupStrategyType

string

No

The full backup epoch. Valid values:

  • simple: periodic backup. This value is used together with BackupPeriod and BackupStartTime.

  • manual: manual backup.

Note

Default value: simple.

simple
BackupLogIntervalSeconds

integer

No

The incremental backup interval in seconds.

Note

Only physical backups are supported.

1000
ClientToken

string

No

The client token that is used to ensure the idempotence of the request and prevent duplicate submissions.

ETnLKlblzczshOTUbOCzxxxxxxx

Response elements

Element

Type

Description

Example

object

HttpStatusCode

integer

The HTTP status code.

200
RequestId

string

The ID of the request.

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

string

The error code.

Param.NotFound
Success

boolean

Indicates whether the request is successful.

true
ErrMessage

string

The error message.

The specified parameter %s value is not valid.

BackupPlanId

string

The ID of the backup plan.

dbstooi01XXXX
NeedPrecheck

boolean

Indicates whether this modification triggers a precheck. If the value is true, a precheck is required, and you must call the StartBackupPlan operation to start the backup plan.

false

Examples

Success response

JSON format

{
  "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": 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.