DescribeAdvancedBackupPolicy - 查询高级备份策略 - 云数据库 MongoDB

查询高级备份策略

接口说明

查询高级备份策略，仅支持云盘副本集与云盘分片集群实例。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例 ID。	dds-bp18b0934e70****

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	111E7B16-0A87-4CBA-B271-F34AD61E099F
DBInstanceId	string	实例 ID。	dds-bp14bf67a76d****
PreferredBackupTime	string	备份时间，格式为HH:mmZ-HH:mmZ（UTC 时间）。	09:00Z-10:00Z
SnapshotBackupType	string	快照备份类型，取值说明： Flash：秒级备份。 Standard：常规备份。	Standard
BackupRetentionPolicyOnClusterDeletion	integer	备份保留策略。 0：实例释放时立即删除该实例的所有备份集 1：实例释放时会长期保留最后一个备份集 2：实例释放时会长期保留所有备份集	2
PreferredNextBackupTime	string	开始备份的时间范围，格式为 `HH:mmZ-HH:mmZ`（UTC 时间），如 01:00Z-02:00Z 。会选择该时间段内的时间开始备份。	2024-06-19T19:11Z
AdvancedBackupDataPolicies	array<object>	备份策略列表。
	object
PolicyId	string	备份策略 ID。	xxxxxx
ActionType	string	处置动作。	xx
RetentionType	string	备份集保留周期类型，返回值如下： never：长期保留 delay：固定天数保留	delay
RetentionPeriod	integer	备份保留天数	7
BackupPolicy	string	高级策略调度类型，取值如下： dayOfWeek：按周调度 dayOfMonth：按月调度 dayOfYear：按年调度 backupInterval：固定间隔调度（高频备份）	dayOfWeek
PreferredBackupPeriod	string	备份周期当BackupPolicy=dayOfWeek : 1,2,3,4,5,6,7 表示周一到周日。当BackupPolicy=dayOfMonth：1,3,-1 表示每月 1、3、和最后一天。当BackupPolicy=dayOfYear ： 01-07 表示 1 月 7 日当BackupPolicy=backupInterval： 30 表示每 30min 备份一次。	1,2,3
SrcRegion	string	实例所在地域。	cn-beijing
SrcType	string	备份策略源类型。 db：同地域备份 level1 ：跨地域备份	db
DestRegion	string	备份策略目标地域。	cn-beijing
DestType	string	备份策略目标类型。 level1 ：同地域备份 level2Cross：跨地域备份	level1
PreserveOneEachHour	boolean	是否开启小时内稀疏备份。 true：当备份频率为分钟级时，距离当前时间 1 小时内的快照全部保留。距离当前时间超过 1 小时且在 24 小时内的快照，仅保留整点后的第一个快照。 false：关闭小时内稀疏备份：高频备份保留天数内的快照全部保留。	False
AdvancedBackupLogPolicies	array<object>	日志备份策略列表。
	object
EnableLogBackup	integer	是否开启日志备份，返回值如下： 1：开启 0：未开启	1
RetentionType	string	日志备份保留周期类型，返回值如下： never：长期保留 delay：固定天数保留	delay
RetentionPeriod	string	日志备份保留天数，当 RetentionType 为 delay 时生效。	4
SrcRegion	string	源实例所在区域。	cn-hangzhou
SrcType	string	日志备份策略源类型。 db：同地域备份 level1 ：跨地域备份	et
DestRegion	string	日志备份策略目标地域。	cn-guangzhou
DestType	string	日志备份策略目标类型。 level1 ：同地域备份 level2Cross：跨地域备份	RDS
PolicyId	string	日志备份策略 id，只有异地日志备份策略存在。	xxxx

示例

正常返回示例

JSON格式

{
  "RequestId": "111E7B16-0A87-4CBA-B271-F34AD61E099F",
  "DBInstanceId": "dds-bp14bf67a76d****",
  "PreferredBackupTime": "09:00Z-10:00Z",
  "SnapshotBackupType": "Standard",
  "BackupRetentionPolicyOnClusterDeletion": 2,
  "PreferredNextBackupTime": "2024-06-19T19:11Z",
  "AdvancedBackupDataPolicies": [
    {
      "PolicyId": "xxxxxx",
      "ActionType": " xx",
      "RetentionType": "delay",
      "RetentionPeriod": 7,
      "BackupPolicy": "dayOfWeek",
      "PreferredBackupPeriod": "1,2,3",
      "SrcRegion": "cn-beijing",
      "SrcType": "db",
      "DestRegion": "cn-beijing",
      "DestType": "level1",
      "PreserveOneEachHour": true
    }
  ],
  "AdvancedBackupLogPolicies": [
    {
      "EnableLogBackup": 1,
      "RetentionType": "delay",
      "RetentionPeriod": "4",
      "SrcRegion": "cn-hangzhou",
      "SrcType": "et",
      "DestRegion": "cn-guangzhou",
      "DestType": "RDS",
      "PolicyId": "xxxx"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidPreferredBackupPeriod.Malformed	Specified parameter PreferredBackupPeriod is not valid.
400	InvalidPreferredBackupTime.Malformed	Specified parameter PreferredBackupTime is not valid.

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

变更历史

更多信息，参考变更详情。