All Products
Search
Document Center

AnalyticDB:ModifyBackupPolicy

Last Updated:Aug 30, 2024

Modifies the backup policy of an AnalyticDB for MySQL cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
adb:ModifyBackupPolicyupdate
  • DBCluster
    acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the cluster.

am-bp1xxxxxxxx47
PreferredBackupTimestringYes

The start time of the full backup within a time range. Specify the time range in the HH:mmZ-HH:mmZ format. The time must be in UTC.

Note The time range is 1 hour.
00:00Z-01:00Z
PreferredBackupPeriodstringYes

The days of the week on which to perform full backup. Separate multiple values with commas (,). Valid values:

  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday
Note To ensure data security, we recommend that you specify at least two values.
Monday,Wednesday,Friday,Sunday
BackupRetentionPeriodstringNo

The number of days for which to retain full backup files. Valid values: 7 to 730.

Note If you leave this parameter empty, the default value 7 is used.
30
EnableBackupLogstringNo

Specifies whether to enable real-time log backup. Valid values:

  • Enable

  • Disable

Note If you leave this parameter empty, the default value Enable is used.
Enable
LogBackupRetentionPeriodintegerNo

The number of days for which to retain log backup files. Valid values: 7 to 730.

Note If you leave this parameter empty, the default value 7 is used.
30

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

1AD222E9-E606-4A42-BF6D-8A4442913CEF

Examples

Sample success responses

JSONformat

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF"
}

Error codes

HTTP status codeError codeError messageDescription
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.

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

Change history

Change timeSummary of changesOperation
No change history