在為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. | 恢復時間內不存在可用的備份。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|
暫無變更歷史