调用DescribeBackupPolicy接口查看集群备份设置。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeBackupPolicy

系统规定参数，取值：

DescribeBackupPolicy。
DBClusterId String 是 am-bp1xxxxxxxx47

实例ID。

返回数据

名称 类型 示例值 描述
BackupRetentionPeriod Integer 7

数据备份保留天数。
EnableBackupLog String true

是否开启。

  • true：开启。
  • false：关闭。
LogBackupRetentionPeriod Integer 7

日志备份保留天数。
PreferredBackupPeriod String Tuesday,Friday

数据备份周期，多个取值用英文逗号（,）隔开。取值：

  • Monday：周一；
  • Tuesday：周二；
  • Wednesday：周三；
  • Thursday：周四；
  • Friday：周五；
  • Saturday：周六；
  • Sunday：周日。
PreferredBackupTime String 15:00Z-16:00Z

数据备份时间，格式：HH:mmZ-HH:mmZ。
RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeBackupPolicy
&DBClusterId=am-bp1xxxxxxxx47
&<公共请求参数>

正常返回示例

XML 格式 

<PreferredBackupPeriod>Tuesday,Friday</PreferredBackupPeriod>
<LogBackupRetentionPeriod>7</LogBackupRetentionPeriod>
<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
<PreferredBackupTime>15:00Z-16:00Z</PreferredBackupTime>
<EnableBackupLog>true</EnableBackupLog>
<BackupRetentionPeriod>7</BackupRetentionPeriod>

JSON 格式 

{
    "PreferredBackupPeriod": "Tuesday,Friday",
    "LogBackupRetentionPeriod": 7,
    "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
    "PreferredBackupTime": "15:00Z-16:00Z",
    "EnableBackupLog": true,
    "BackupRetentionPeriod": 7
}

错误码

HttpCode 错误码 错误信息 描述
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。

访问错误中心查看更多错误码。