接口功能介绍
调用describeRootAccoun查询MongoDB实例的数据库root账号信息。
接口约束
无
URI
GET /v1/accountsOpenApi/describeRootAccount
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| prodInstId | 是 | String | 文档数据库对外的实例标识 | 60d420bffb394397b4303be871a481e3 |
请求参数
请求头header参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 下级对象 | |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 响应码 取值范围：800为成功，900为失败 |
800 | |
| message | 是 | String | 响应信息 | 查询MongoDB实例的主机告警规则成功 | |
| returnObj | 是 | Object | 返回对象 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| ProdInstId | 是 | String | 实例ID | 60d420bffb394397b4303be871a481e3 | |
| AccountName | 是 | String | 账户名 | root | |
| ProdType | 是 | String | 实例类型，0代表单节点，2代表一主两从 | 2 | |
| AccountStatus | 是 | String | 账户状态 | Available | |
| AccountDescription | 是 | String | 账号备注信息 | Administrator |
请求示例
请求头header
无
请求参数query
/v1/accountsOpenApi/describeRootAccoun?prodInstId=60d420bffb394397b4303be871a481e3
响应示例
{
"statusCode": 800,
"message": "查询MongoDB实例的数据库账号信息成功",
"returnObj": {
"AccountDescription": "Administrator",
"AccountStatus": "Available",
"ProdType": "2",
"ProdInstId": "60d420bffb394397b4303be871a481e3 ",
"AccountName": "root"
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
| 900 | 表示请求失败 |
错误码
无
