API Introduction
Call the checkRecoveryCondition API to check whether the MongoDB instance meets the conditions for data recovery.
API Restrictions
None
URI
POST /v1/openApi/checkRecoveryCondition
Path Parameter
None
Query Parameter
None
Request Parameters
Request Header Parameter
None
Request Body Parameter
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
srcProdInstId | Yes | String | Source instance ID | 0addb92d52a84ffdbaa79fdada8a1833 | |
dstProdInstId | Yes | String | Target instance ID | 7eb8d17d789047d2892d9f1ec89a20ac | |
backupName | Yes | String | Backup Name | autoBackup_20221027003505477 |
Response Parameter
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
statusCode | Yes | Integer | Response Code Value range: 800 indicates success, 900 indicates failure | 800 | |
message | Yes | String | Response information | Whether the MongoDB instance meets the conditions for data recovery is checked successfully | |
returnObj | Yes | Object | Return object. |
Table returnObj
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
canRecovery | Yes | Integer | Whether the conditions for data recovery are met, true indicates met, false indicates not met | true |
Sample Request
Request Header
None
Request Body
{
"srcProdInstId":"0addb92d52a84ffdbaa79fdada8a1833",
"dstProdInstId":"7eb8d17d789047d2892d9f1ec89a20ac",
"backupName":"autoBackup_20221027003505477"
}Response Example
{
"statusCode": 800,
"message": "whether the MongoDB instance meets the conditions for data recovery is checked successfully",
"returnObj": {
"canRecovery": "true"
}
}Status Code
Status Code | Description |
800 | Indicate that the request succeeded |
900 | Indicates that the request failed |
Error Codes
None