You can call this operation to query the automatic backup policy of a specified ApsaraDB for POLARDB 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
DBClusterId String Yes pc-bpxxxxxxx

The ID of the ApsaraDB for POLARDB cluster.

AccessKeyId String No key-test

The AccessKey ID provided to you by Alibaba Cloud.

Action String No DescribeBackupPolicy

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

Response parameters

Parameter Type Example Description
BackupRetentionPeriod Integer 7

The retention period of the backup data.

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

The period of data backup. Valid values:

  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday
PreferredBackupTime String 14:00Z-15:00Z

The time for automatic backup. The time is displayed in UTC.

PreferredNextBackupTime String 2019-07-27T14:32Z

The time for the next backup. The time is displayed in UTC.

RequestId String 36590CA1-BAEE-4034-9CDD-33FFEC8C6BAE

The ID of the request.

Examples

Sample requests


http(s)://[Endpoint]/? Action=DescribeBackupPolicy
&DBClusterId=pc-bpxxxxxxx
&<Common request parameters>

Sample success responses

XML format

<DescribeBackupPolicyResponse>
  <PreferredBackupPeriod>Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday</PreferredBackupPeriod>
      <RequestId>36590CA1-BAEE-4034-9CDD-33FFEC8C6BAE</RequestId>
      <PreferredBackupTime>14:00Z-15:00Z</PreferredBackupTime>
      <PreferredNextBackupTime>2019-07-27T14:32Z</PreferredNextBackupTime>
      <BackupRetentionPeriod>7</BackupRetentionPeriod>
</DescribeBackupPolicyResponse>

JSON format

{
	"PreferredBackupPeriod":"Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday",
	"RequestId":"36590CA1-BAEE-4034-9CDD-33FFEC8C6BAE",
	"BackupRetentionPeriod":7,
	"PreferredNextBackupTime":"2019-07-27T14:32Z",
	"PreferredBackupTime":"14:00Z-15:00Z"
}

Error codes

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