API Introduction
Call the modifyDBInstanceDescription API to modify the instance name.
API Restrictions
None
URI
POST /v1/openApi/modifyDBInstanceDescription
Path Parameter
None
Query Parameter
None
Request Parameters
Request Header Parameter
None
Request Body Parameter
Parameter | Required or Not | Parameter Type | Description | Example |
prodInstId | *Required | String | External instance ID of the document database | a649077e15f349cb8b4cde6f7285a568 |
prodInstName | *Required | String | New instance name | test002 |
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 | The XXX information is queried successfully |
Sample Request
Request Header
None
Request Body
{
"prodInstId":"a649077e15f349cb8b4cde6f7285a568",
"prodInstName":"test002"
}Response Example
{
"statusCode": 800,
"message": "The name of the mongoDB instance is modified successfully"
}Status Code
Status Code | Description |
800 | Indicate that the request succeeded |
900 | Indicates that the request failed |
Error Codes
None