检查MongoDB实例是否满足数据恢复的条件。
接口说明
本接口适用于副本集实例或分片集群实例。
说明
调用本接口确认满足数据恢复的条件后,您可以调用 CreateDBInstance 接口,将数据恢复至新实例。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dds:CheckRecoveryCondition | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
SourceDBInstance | string | 是 | 待恢复的源实例 ID。 | dds-bp1378**** |
DatabaseNames | string | 否 | 所需恢复的数据库名,格式为 JSON 数组。 说明
如果不传入本参数,默认恢复所有数据库。
| ["db1","db2"] |
RestoreTime | string | 否 | 实例所需恢复的时间点,格式为 yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 说明
| 2022-08-22T08:00:00Z |
BackupId | string | 否 | 备份 ID。 说明
| 5664**** |
ResourceGroupId | string | 否 | 资源组 ID。 | sg-bp179**** |
SrcRegion | string | 否 | 源实例所在区域。 说明
| cn-beijing |
DestRegion | string | 否 | 异地备份恢复时,备份集所在区域。 说明
当备份恢复类型为异地备份克隆时,需要且必填
| cn-hangzhou |
RestoreType | string | 否 | 备份恢复类型 说明
| 0 |
InstanceType | string | 否 | 实例类型,取值:
说明
| replicate |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "D563A3E7-6010-45FE-A0CD-9283414C9657",
"DBInstanceName": "dds-bp1378****",
"IsValid": true
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidMeta.WrongFormat | Meta information is wrong formatter. | - |
400 | InvalidRestoreTime.Format | Specified restore time is not valid. | 指定的参数RestoreTime不合法,请您检查输入的参数是否正确。 |
403 | InvalidDBName | The specified database name is not allowed. | 指定的数据库名称无效 |
403 | InvalidMeta.TooLarge | Meta information is too large. | 元信息太大。 |
403 | SingleDBRestore.BackupSetNotSupport | This backup set do not support this operation. | 所选择的时间点或备份文件尚未支持单库恢复功能。 |
403 | IncorrectDBInstanceType | Current DB instance type does not support this operation. | 当前实例类型不支持该操作。 |
403 | IncorrectEngineVersion | Current engine version does not support operations. | - |
403 | InvalidBackupLogStatus | Current backup log enable status does not support this operation. | 当前备份日志启用状态不支持此操作。 |
403 | IncorrectBackupSetState | Current backup set state does not support operations.. | - |
404 | InvalidBackupSetID.NotFound | Specifiedbackup set ID does not exist. | - |
404 | InvalidBackup.NotFound | Theavailable backup does not exist in recovery time. | 恢复时间内不存在可用的备份。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史