接口功能介绍
调用describeDBInstancesOverview查询一个或多个MongoDB实例的概览信息。
接口约束
无
URI
GET /v1/openApi/describeDBInstancesOverview
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstIds | 是 | String | 产品ID | 555b89493b1a40e1b97ea05e50dd8170 |
请求参数
请求头header参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | String | 返回码 取值范围：800 成功 |
800 | |
| message | 是 | String | 返回消息 | ||
| returnObj | 是 | Object[] | 返回对象数组 | returnObj |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstName | 是 | String | 实例名称 | mongodb001 | |
| userId | 是 | Integer | 用户id | 124 | |
| enableSSL | 是 | Integer | 'enableSSL表示是否开启ssl连接，1表示开启，0表示未开启' | 1 | |
| diskSize | 是 | Integer | 磁盘空间 | 300 | |
| createTime | 是 | Integer | 创建时间 | 1658458503000 | |
| port | 是 | String | 主机端口 | 8350 | |
| diskRate | 是 | String | 查询磁盘使用率 | 32% | nodeInfoVOS |
nodeInfoVOS
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| node | 是 | String | 子节点名称 | mongodb001 | |
| role | 是 | String | 角色 | master | |
| vpcIpv6 | 是 | Integer | vpc内部的ipv6地址 | ||
| port | 是 | String | 主机端口 | 8832 | |
| host | 是 | String | 主机地址 | 172.27.176.109 | |
| prodInstId | 是 | String | 实例id | ||
| resId | 是 | Integer | 唯一标志该mongodb |
请求示例
请求头header
无
请求参数query
/v1/openApi/describeDBInstancesOverview?prodInstIds=555b89493b1a40e1b97ea05e50dd8170
响应示例
{
"statusCode": 800,
"message": "查询MongoDB实例概览信息成功",
"returnObj": [
{
"prodInstName": "mongodb001",
"prodType": null,
"userId": 149,
"enableSSL": 0,
"diskSize": 3072,
"createTime": 1658458503000,
"port": "8350",
"prodRunningStatus": 0,
"diskRate": "14%",
"nodeInfoVOS": [
{
"elasticIp": "",
"node": "set_1098350_1",
"role": "master",
"alive": 1,
"vpcIpv6": "",
"port": "8350",
"host": "172.27.176.109",
"prodInstId": "c46d8f547cc648a78a68270092e70f80",
"type": null,
"resId": 67
}
],
"host": "172.27.176.109",
"prodInstId": "c46d8f547cc648a78a68270092e70f80",
"machineSpec": "64C500G"
}
]
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功。 |
| 900 | 请求响应失败，失败原因见message |
错误码
请参考错误码说明。
