API Introduction
Call changeAccountDescription to modify the remarks of the root account in the MongoDB instance.
API Restrictions
None
URI
POST /v1/accountsOpenApi/changeAccountDescription
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 | 60d420bffb394397b4303be871a481e3 | |
accountDescription | Yes | String | Account remarks | Administrator account |
Response Parameter
Parameter | Required or Not | Parameter Type | Description | Lower-level Object | |
statusCode | Yes | Integer | Response Code Value range: 800 indicates success, 900 indicates failure | 800 | |
message | Yes | String | Response information | The host alarm rules of the MongoDB instance are queried successfully | |
returnObj | Yes | Object | Return object. | returnObj |
Table returnObj
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
ProdInstId | Yes | String | Instance ID | 60d420bffb394397b4303be871a481e3 | |
AccountDescription | Yes | String | Account remarks | Administrator account |
Sample Request
Request Header
None
Request Body
{
"prodInstId":"60d420bffb394397b4303be871a481e3",
"accountDescription":"Administrator account"}Response Example
{
"statusCode": 800,
"message": "the remarks of the root account in the MongoDB instance are modified successfully",
"returnObj": {
"ProdInstId": "60d420bffb394397b4303be871a481e3",
"AccountDescription": "Administrator account"
}
}Status Code
Status Code | Description |
800 | Indicate that the request succeeded |
900 | Indicates that the request failed |
Error Codes
None