AI 助理
备案控制台
文档
输入文档关键字查找
首页 云数据库 MongoDB 版 开发参考 API参考指南 API目录 备份与恢复 CheckRecoveryCondition - 检查实例是否满足数据恢复条件

CheckRecoveryCondition - 检查实例是否满足数据恢复条件

更新时间：
产品详情
我的收藏

检查MongoDB实例是否满足数据恢复的条件。

接口说明

本接口适用于副本集实例或分片集群实例。

说明 调用本接口确认满足数据恢复的条件后，您可以调用 CreateDBInstance 接口，将数据恢复至新实例。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
dds:CheckRecoveryConditionget
  • Instance
    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    无
无

请求参数

名称类型必填描述示例值
SourceDBInstancestring是

待恢复的源实例 ID。

dds-bp1378****
DatabaseNamesstring否

所需恢复的数据库名，格式为 JSON 数组。

说明 如果不传入本参数，默认恢复所有数据库。
["db1","db2"]
RestoreTimestring否

实例所需恢复的时间点，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

说明
  • 本参数可取值为 7 天内的任意时间，但是须早于当前时间，且晚于实例的创建时间。
  • 本参数和 BackupId 参数两者中必须传入一项。
    •
    		2022-08-22T08:00:00Z
    BackupIdstring否

    备份 ID。

    说明
  • 您可以通过调用 DescribeBackups 接口查询备份 ID。
  • 本参数和 RestoreTime 参数两者中必须传入一项。
  • 分片集群实例不支持传入本参数。
    •
    		5664****
    ResourceGroupIdstring否

    资源组 ID。

    		sg-bp179****
    SrcRegionstring否

    源实例所在区域。

    说明
  • 当备份恢复类型为已删除实例重建时，需要且必填
  • 当备份恢复类型为异地备份克隆时，需要且必填
    •
    		cn-beijing
    DestRegionstring否

    异地备份恢复时，备份集所在区域。

    说明 当备份恢复类型为异地备份克隆时，需要且必填
    		cn-hangzhou
    RestoreTypestring否

    备份恢复类型

    说明
  • 0: 本地备份恢复
  • 1: 本地时间点恢复
  • 2: 已删除实例使用备份集备份恢复
  • 3: 异地备份使用备份集备份恢复
    •
    		0
    InstanceTypestring否

    实例类型，取值：

    • replicate
    • sharding
    说明
  • 当备份恢复类型为已删除实例重建时，需要且必填
  • 当备份恢复类型为异地备份克隆时，需要且必填
    •
    		replicate
    EngineVersionstring否

    数据库版本号，取值：

    • 7.0
    • 6.0
    • 5.0
    • 4.4
    • 4.2
    • 4.0
    		4.2

    返回参数

    名称类型描述示例值
    object

    返回信息。

    RequestIdstring

    请求 ID。

    		D563A3E7-6010-45FE-A0CD-9283414C9657
    DBInstanceNamestring

    实例 ID。

    		dds-bp1378****
    IsValidboolean

    是否满足恢复条件，取值说明：

    • true：满足条件。
    • false：不满足条件。
    		true

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "D563A3E7-6010-45FE-A0CD-9283414C9657",
  "DBInstanceName": "dds-bp1378****",
  "IsValid": true
}

    错误码

    HTTP status code错误码错误信息描述
    400InvalidMeta.WrongFormatMeta information is wrong formatter.-
    400InvalidRestoreTime.FormatSpecified restore time is not valid.指定的参数RestoreTime不合法，请您检查输入的参数是否正确。
    403InvalidDBNameThe specified database name is not allowed.指定的数据库名称无效
    403InvalidMeta.TooLargeMeta information is too large.元信息太大。
    403SingleDBRestore.BackupSetNotSupportThis backup set do not support this operation.所选择的时间点或备份文件尚未支持单库恢复功能。
    403IncorrectDBInstanceTypeCurrent DB instance type does not support this operation.当前实例类型不支持该操作。
    403IncorrectEngineVersionCurrent engine version does not support operations.-
    403InvalidBackupLogStatusCurrent backup log enable status does not support this operation.当前备份日志启用状态不支持此操作。
    403IncorrectBackupSetStateCurrent backup set state does not support operations..-
    404InvalidBackupSetID.NotFoundSpecifiedbackup set ID does not exist.-
    404InvalidBackup.NotFoundTheavailable backup does not exist in recovery time.恢复时间内不存在可用的备份。

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

    变更历史

    变更时间变更内容概要操作
    2024-10-29OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
    上一篇：DescribeBackupDBs - 查询指定的时间点或备份集内包含的数据库下一篇：DescribeRestoreDBInstanceList - 查询MongoDB实例的备份恢复实例
    文档推荐