调用DescribeBackupPolicy接口查询云数据库MongoDB实例的备份策略。

调试

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

请求参数

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

系统规定参数。取值：DescribeBackupPolicy。

DBInstanceId String 是 dds-bp16cb162771****

实例ID。

返回数据

名称 类型 示例值 描述
PreferredBackupPeriod String Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday

备份周期，取值说明：

  • Monday：星期一。
  • Tuesday：星期二。
  • Wednesday：星期三。
  • Thursday：星期四。
  • Friday：星期五。
  • Saturday：星期六。
  • Sunday：星期日。
RequestId String 5A9464CA-F7DC-5434-90B1-DF7F197C****

请求ID。
PreferredBackupTime String 09:00Z-10:00Z

备份时间，格式为HH:mmZ-HH:mmZ（UTC时间）。

BackupRetentionPeriod String 30

备份保留天数。
EnableBackupLog Integer 1

是否打开日志备份，取值说明：

  • 0：关闭（默认值）。
  • 1：打开。
LogBackupRetentionPeriod Integer 7

日志备份保留天数，取值范围：7~730。
SnapshotBackupType String Standard

快照备份类型，取值说明：

  • Flash：秒级备份。
  • Standard：常规备份（默认值）。
BackupInterval Integer -1

高频备份频率，取值说明：

  • -1：不开启高频备份。
  • 15：每15分钟。
  • 30：每30分钟。
  • 60：每1小时。
  • 120：每2小时。
  • 180：每3小时。
  • 240：每4小时。
  • 360：每6小时。
  • 480：每8小时。
  • 720：每12小时。

示例

请求示例

http(s)://mongodb.aliyuncs.com/?Action=DescribeBackupPolicy
DBInstanceId=dds-bp16cb162771****
&<公共请求参数>

正常返回示例

XML格式 

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

<DescribeBackupPolicyResponse>
    <PreferredBackupPeriod>Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday</PreferredBackupPeriod>
    <RequestId>5A9464CA-F7DC-5434-90B1-DF7F197C****</RequestId>
    <PreferredBackupTime>09:00Z-10:00Z</PreferredBackupTime>
    <BackupRetentionPeriod>30</BackupRetentionPeriod>
    <EnableBackupLog>1</EnableBackupLog>
    <LogBackupRetentionPeriod>7</LogBackupRetentionPeriod>
    <SnapshotBackupType>Standard</SnapshotBackupType>
    <BackupInterval>-1</BackupInterval>
</DescribeBackupPolicyResponse>

JSON格式 

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

{
  "PreferredBackupPeriod" : "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday",
  "RequestId" : "5A9464CA-F7DC-5434-90B1-DF7F197C****",
  "PreferredBackupTime" : "09:00Z-10:00Z",
  "BackupRetentionPeriod" : 30,
  "EnableBackupLog" : 1,
  "LogBackupRetentionPeriod" : 7,
  "SnapshotBackupType" : "Standard",
  "BackupInterval" : -1
}

错误码

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