Queries the backup policy of an ApsaraDB for Redis instance, such as 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 the value to DescribeBackupPolicy.

InstanceId String Yes r-bp1zxszhcgatnx****

The ID of the instance.

RegionId String No cn-hangzhou

The ID of the region where the instance is deployed.

Response parameters

Parameter Type Example Description
BackupRetentionPeriod String 7

The retention period for backups. Unit: days.

EnableBackupLog Integer 1

Specifies whether incremental backup is enabled. Valid values:

  • 1: enabled.
  • 0: disabled.
PreferredBackupPeriod String Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday

The backup cycle. Valid values:

  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday
PreferredBackupTime String 05:00Z-06:00Z

The time when the data was backed up. The time follows the ISO 8601 standard in the HH:mmZ-HH:mmZ format. The time is displayed in UTC.

PreferredNextBackupTime String 2019-03-14T05:28Z

The next backup time. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.

RequestId String 90B82DB7-FB28-4CC2-ADBF-1F8659F3****

The ID of the request.

Examples

Sample requests

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

Sample success responses

XML format

<DescribeBackupPolicyResponse>
      <PreferredBackupPeriod>Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday</PreferredBackupPeriod>
      <RequestId>90B82DB7-FB28-4CC2-ADBF-1F8659F3****</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-1F8659F3****",
	"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.