You can call DescribeBackupPolicy to query the backup policy of an ApsaraDB for Redis instance, including the backup cycle and backup time.

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 DescribeBackupPolicy

The operation that you want to perform. Set this parameter to DescribeBackupPolicy.

InstanceId String Yes r-bp1xxxxxxxxxxxxx

The ID of the instance.

RegionId String No cn-hangzhou

The ID of the region where the instance resides.

Response parameters

Parameter Type Example Description
RequestId String 90B82DB7-FB28-4CC2-ADBF-1F8659F30C26

The ID of the request.

BackupRetentionPeriod String 7

The backup retention period. Unit: days.

PreferredBackupTime String 05:00Z-06:00Z

Backup time in UTC. Format:HH:mmZ-HH:mmZ.

PreferredBackupPeriod String Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday

The backup cycle. Valid values:

  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday
PreferredNextBackupTime String 2019-03-14T05:28Z

The time when the backup is performed next time.

EnableBackupLog Integer 1

Indicates whether incremental backup is enabled. Valid values:

  • 1 indicates it is enabled.
  • 0 indicates it is not enabled.

Examples

Sample requests

https://r-kvstore.aliyuncs.com/
?Action=DescribeBackupPolicy
&InstanceId=r-bp1xxxxxxxxxxxxx
&<Common request parameters>

Sample success responses

XML format

<DescribeBackupPolicyResponse>
      <PreferredBackupPeriod>Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday</PreferredBackupPeriod>
      <RequestId>90B82DB7-FB28-4CC2-ADBF-1F8659F30C26</RequestId>
      <PreferredNextBackupTime>2018-10-26T19:05Z</PreferredNextBackupTime>
      <PreferredBackupTime>19:00Z-20:00Z</PreferredBackupTime>
      <BackupRetentionPeriod>7</BackupRetentionPeriod>
</DescribeBackupPolicyResponse>

JSON format

{
    "PreferredBackupPeriod": "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday",
    "RequestId": "90B82DB7-FB28-4CC2-ADBF-1F8659F30C26",
    "PreferredNextBackupTime": "2018-10-26T19:05Z",
    "PreferredBackupTime": "19:00Z-20:00Z",
    "BackupRetentionPeriod": "7"
}

Error codes

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