API Introduction
Call the createBackup API to manually back up the MongoDB instance.
API Restrictions
None
URI
POST /v1/openApi/createBackup
Path Parameter
None
Query Parameter
None
Request Parameters
Request Header Parameter
None
Request Body Parameter
Parameter | Required or Not | Parameter Type | Description | Instance | Lower-level Object |
prodInstId | Yes | String | Instance ID | f3687b55b1ce4cb1b781fb567b12ab0b | |
backupName | Yes | String | Backup Name | ||
description | No | String | Backup Description |
Response Parameter
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
statusCode | Yes | String | Return code Value range: 800 indicates success | 800 | |
message | Yes | String | Return to Messages | ||
returnObj | Yes | Object | Return object. | returnObj |
Table returnObj
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
code | No | String | 0 indicates success | 0, non-0 indicates failure |
Sample Request
Request Body
{
"prodInstId":"f3687b55b1ce4cb1b781fb567b12ab0b",
"backupName":"test005"
}Response Example
{
"statusCode": 800,
"message": "the MongoDB instance is manually backup successfully",
"returnObj": {
"code": 0
}
}Status Code
Status Code | Description |
800 | Indicate that the request succeeded |
900 | Request response failed, see message for reason of failure |
Error Codes
None