API Introduction
Call the restartDb API to restart the MongoDB database instance.
API Restrictions
None
URI
POST /v1/openApi/restartDb
Request Parameters
Request Header Parameter
None
Request Body Parameter
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
prodInstId | Yes | String | Instance ID. | f3687b55b1ce4cb1b781fb567b12ab0b |
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. |
Sample Request
Request Body
{
"prodInstId": "f3687b55b1ce4cb1b781fb567b12ab0b"
}Response Example
{
"statusCode": 800,
"message": "the command to restart the database is sent successfully",
"returnObj": null
}Status Code
Status Code | Description |
800 | Indicate that the request succeeded |
900 | Request response failed, see message for reason of failure |
Error Codes
None