调用DescribeBackupPolicy接口查询MongoDB实例的备份策略。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 否 | DescribeBackupPolicy | 系统规定参数。取值:DescribeBackupPolicy。 |
| RegionId | String | 否 | cn-hangzhou | 实例所属的地域ID,您可以通过调用DescribeDBInstanceAttribute进行查询。 |
| DBInstanceId | String | 是 | dds-bp16cb162771**** | 实例ID。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| PreferredBackupPeriod | String | 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 | 0 | 是否打开日志备份,默认为0(关闭)。
|
| LogBackupRetentionPeriod | Integer | 0 | 日志备份保留天数。 |
示例
请求示例
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>
<LogBackupRetentionPeriod>0</LogBackupRetentionPeriod>
<RequestId>5A9464CA-F7DC-5434-90B1-DF7F197C****</RequestId>
<PreferredBackupTime>09:00Z-10:00Z</PreferredBackupTime>
<EnableBackupLog>0</EnableBackupLog>
<BackupRetentionPeriod>30</BackupRetentionPeriod>
<PreferredNextBackupTime>2021-09-09T09:22Z</PreferredNextBackupTime>
</DescribeBackupPolicyResponse>
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"PreferredBackupPeriod" : "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday",
"LogBackupRetentionPeriod" : 0,
"RequestId" : "5A9464CA-F7DC-5434-90B1-DF7F197C****",
"PreferredBackupTime" : "09:00Z-10:00Z",
"EnableBackupLog" : 0,
"BackupRetentionPeriod" : "30",
"PreferredNextBackupTime" : "2021-09-09T09:22Z"
}
错误码
访问错误中心查看更多错误码。