查询MongoDB实例的备份策略。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
dds:DescribeBackupPolicy |
get |
*dbinstance
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
DBInstanceId |
string |
是 |
实例 ID。 |
dds-bp16cb162771**** |
InstanceType |
string |
否 |
实例类型。
|
sharding |
SrcRegion |
string |
否 |
实例所在地域。 |
cn-beijing |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
返回数据。 |
||
PreferredBackupPeriod |
string |
备份周期,取值说明:
|
Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday |
RequestId |
string |
请求 ID。 |
5A9464CA-F7DC-5434-90B1-DF7F197C**** |
PreferredBackupTime |
string |
备份时间,格式为HH:mmZ-HH:mmZ(UTC 时间)。 |
09:00Z-10:00Z |
BackupRetentionPeriod |
string |
备份保留天数。 |
30 |
PreferredNextBackupTime |
string |
下次常规备份时间,格式为yyyy-mm-ddthh:mmz(utc 时间)。 |
2024-06-19T19:11Z |
EnableBackupLog |
integer |
是否打开日志备份,取值说明:
|
1 |
LogBackupRetentionPeriod |
integer |
日志备份保留天数,取值范围:7~730。 |
7 |
SnapshotBackupType |
string |
快照备份类型,取值说明:
|
Standard |
BackupInterval |
integer |
高频备份频率,取值说明:
|
-1 |
HighFrequencyBackupRetention |
string |
高频备份保留天数,单位为天。 |
1 |
BackupRetentionPolicyOnClusterDeletion |
integer |
备份保留策略。
详细信息请参见:长期保留备份 |
0 |
SrcRegion |
string |
源实例所在区域。 |
cn-hangzhou |
DestRegion |
string |
异地备份所在地域。 |
cn-shenzhen |
CrossRetentionType |
string |
异地备份保留类型。
|
delay |
CrossRetentionValue |
integer |
异地备份保留时长。 |
7 |
CrossBackupPeriod |
string |
异地备份的保留时间。
说明
异地备份必填 |
Monday |
EnableCrossLogBackup |
integer |
是否开启跨地域日志备份 。 说明
异地备份必填
|
1 |
CrossLogRetentionType |
string |
异地日志备份保留类型。
|
delay |
CrossLogRetentionValue |
integer |
异地日志备份保留时长。 |
7 |
PreserveOneEachHour |
boolean |
是否开启小时内稀疏备份。
|
false |
示例
正常返回示例
JSON
格式
{
"PreferredBackupPeriod": "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday",
"RequestId": "5A9464CA-F7DC-5434-90B1-DF7F197C****",
"PreferredBackupTime": "09:00Z-10:00Z",
"BackupRetentionPeriod": "30",
"PreferredNextBackupTime": "2024-06-19T19:11Z",
"EnableBackupLog": 1,
"LogBackupRetentionPeriod": 7,
"SnapshotBackupType": "Standard",
"BackupInterval": -1,
"HighFrequencyBackupRetention": "1",
"BackupRetentionPolicyOnClusterDeletion": 0,
"SrcRegion": "cn-hangzhou",
"DestRegion": "cn-shenzhen",
"CrossRetentionType": "delay",
"CrossRetentionValue": 7,
"CrossBackupPeriod": "Monday",
"EnableCrossLogBackup": 1,
"CrossLogRetentionType": "delay",
"CrossLogRetentionValue": 7,
"PreserveOneEachHour": false
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。