檢查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 |
EngineVersion | string | 否 | 數據庫版本號,取值:
| 4.2 |
返回參數
示例
正常返回示例
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. | 恢復時間內不存在可用的備份。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-10-29 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |