在为MongoDB实例执行单库恢复前，您可以调用本接口查询指定的时间点或备份集内包含的数据库。
接口说明
您可以调用 CreateDBInstance 接口进行单库恢复。更多信息，请参见 MongoDB 单库恢复。
调用本接口时，实例必须满足以下条件：
- 实例的创建时间晚于 2019 年 3 月 26 日。
- 实例属于华北 1、华北 2、华北 3、华北 5、华东 1、华东 2、华南 1 或亚太东南 1（新加坡）地域。
- 实例类型为副本集实例。
- 实例版本须为 3.4、4.0、4.2 本地盘版本。
- 实例存储引擎必须为 WiredTiger。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| PageNumber | integer | 否 | 页码，取值为大于 0 且不超过 Integer 数据类型的最大值，默认值为 1。 | 1 |
| PageSize | integer | 否 | 每页可展示的记录数。取值： 30（默认值）、50、100。 | 30 |
| SourceDBInstance | string | 是 | 待恢复数据的源实例 ID。 | dds-bp2286**** |
| RestoreTime | string | 否 | 实例所需恢复的时间点，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 说明
| 2019-08-22T12:00:00Z |
| BackupId | string | 否 | 备份 ID。 说明
| 5664**** |
| ResourceGroupId | string | 否 | 资源组 ID。 | rg-ax68**** |
返回参数
示例
正常返回示例
JSON格式
{
"TotalCount": 5,
"Databases": {
"Database": [
{
"DBName": "mongodbtest"
}
]
},
"RequestId": "1AF0AD89-ED4F-44AD-B65F-BFC1D5CD9455",
"PageSize": 30,
"PageNumber": 1
}错误码
| 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. | 恢复时间内不存在可用的备份。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史