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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ModifyBackupPolicy

The operation that you want to perform. Set the value to ModifyBackupPolicy.

DBClusterId String Yes am-bp1xxxxxxxx47

The ID of the cluster.

PreferredBackupTime String Yes 00:00Z-01:00Z

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.
PreferredBackupPeriod String Yes Monday,Wednesday,Friday,Sunday

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.
BackupRetentionPeriod String No 30

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.
EnableBackupLog String No Enable

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.
LogBackupRetentionPeriod Integer No 30

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.

Response parameters

Parameter Type Example Description
RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ModifyBackupPolicy
&DBClusterId=am-bp1xxxxxxxx47
&PreferredBackupTime=00:00Z-01:00Z
&PreferredBackupPeriod=Monday,Wednesday,Friday,Sunday
&BackupRetentionPeriod=30
&EnableBackupLog=Enable
&LogBackupRetentionPeriod=30
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyBackupPolicyResponse>
    <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
</ModifyBackupPolicyResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HTTP status code Error code Error message Description
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The error message returned because the specified DBClusterId parameter does not exist. Check whether the cluster ID is valid.

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