接口功能介绍
调用changeAccountDescription修改MongoDB实例中root账号的备注信息。
接口约束
无
URI
POST /v1/accountsOpenApi/changeAccountDescription
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 实例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 实例ID | 60d420bffb394397b4303be871a481e3 | |
| accountDescription | 是 | String | 账户备注 | 管理员账号 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 下级对象 | |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 响应码 取值范围：800为成功，900为失败 |
800 | |
| message | 是 | String | 响应信息 | 查询MongoDB实例的主机告警规则成功 | |
| returnObj | 是 | Object | 返回对象 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| ProdInstId | 是 | String | 实例ID | 60d420bffb394397b4303be871a481e3 | |
| AccountDescription | 是 | String | 账号备注信息 | 管理员账号 |
请求示例
请求头header
无
请求体body
{
"prodInstId":"60d420bffb394397b4303be871a481e3",
"accountDescription":"管理员账号"}
响应示例
{
"statusCode": 800,
"message": "修改MongoDB实例中root账号的备注信息成功",
"returnObj": {
"ProdInstId": "60d420bffb394397b4303be871a481e3",
"AccountDescription": "管理员账号"
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
| 900 | 表示请求失败 |
错误码
无
