API Introduction
Call the releaseInstance API to release the instance.
API Restrictions
The instance can only be released if its running status is abnormal, frozen, or construction failed (running status code: 5- abnormal, 7- frozen, 10- construction failed).
URI
POST /v1/lifeCycleManageOpenApi/releaseInstance
Path Parameter
None
Query Parameter
None
Request Parameters
Request Header Parameter
None
Request Body Parameter
Parameter | Required or Not | Parameter Type | Description | Example |
prodInstId | Yes | String | External instance ID of the document database | a649077e15f349cb8b4cde6f7285a568 |
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 | Instance release succeeded/failed | |
returnObj | Yes | Object | Return object. |
Sample Request
Request Header
None
Request Body
{
"prodInstId":"a649077e15f349cb8b4cde6f7285a568"
}Response Example
{
"statusCode": 800,
"message": "the MongoDB instance is released successfully",
"returnObj": null
}Status Code
Status Code | Description |
800 | Indicate that the request succeeded |
900 | Indicates that the request failed |
Error Codes
None