查询实例概览信息v2
更新时间 2025-10-22 18:09:53
最近更新时间: 2025-10-22 18:09:53
接口功能介绍
查询一个或多个文档数据库实例的概览信息
接口约束
无
URI
GET /DDS2/v2/openApi/describeDBInstancesOverview
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstIds | 是 | String | 产品ID | 60d420bffb394************************* |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| project-id | 否 | String | 项目id | 0 | |
| regionId | 是 | String | 资源池id | bb9fdb42056f11eda1610242ac110002 |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 返回码 取值范围：800 成功 | 800 | |
| message | String | 返回消息 | 查询MongoDB实例概览信息成功 | |
| returnObj | Object | 返回对象数组 | returnObj | |
| error | String | 错误码。当接口失败时才返回具体错误编码，成功不返回或者为空。 | ||
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| prodInstName | String | 实例名称 | mongodb001 | |
| userId | Integer | 用户id | 124 | |
| enableSSL | Integer | 'enableSSL表示是否开启ssl连接，1表示开启，0表示未开启' | 1 | |
| diskSize | Integer | 磁盘空间 | 300 | |
| createTime | Integer | 创建时间 | 1658458503000 | |
| port | String | 主机端口 | 8350 | |
| prodType | String | 实例类型 | null | |
| diskRate | String | 查询磁盘使用率 | 32% | nodeInfoVOS |
| prodRunningStatus | Integer | 实例运行状态 实例运行状态: 0->运行正常, 1->重启中, 2-备份操作中,3->恢复操作中,4->转换ssl,5->异常,6->修改参数组中,7->已冻结,8->已注销,9->施工中,10->施工失败,11->扩容中,12->主备切换中 | 0 | |
| cpuType | Integer | cpu类型，10-Kunpeng，20-Haiguang，30-Intel，40-AMD，50-Feiteng，60-Longxin，70-Zhaoxin | 30 | |
| hostSeries | String | 性能类型，S系列-通用型，C系列-计算增强型，M系列-内存优化型 | S7 | |
| 表 nodeInfoVOS |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| node | String | 子节点名称 | mongodb001 | |
| role | String | 角色 | master | |
| vpcIpv6 | Integer | vpc内部的ipv6地址 | ||
| port | String | 主机端口 | 8832 | |
| host | String | 主机地址 | 172.27.. | |
| prodInstId | String | 实例id | 60d420bffb394************************* | |
| resId | Integer | 唯一标志该mongodb | 1 | |
| elasticIp | String | 弹性ip | 172.27.. | |
| alive | Integer | (已弃用) | 1 |
枚举参数
无
请求示例
请求url
/v1/openApi/describeDBInstancesOverview?prodInstIds=60d420bffb394*************************
请求头header
project-id=0
regionId=bb9fdb42056f11eda1610242ac110002
请求体body
无
响应示例
{
"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.***.***",
"prodInstId": "c46d8f547cc648a78a68270092e70f80",
"type": null,
"resId": 67
}
],
"host": "172.27.***.***",
"prodInstId": "c46d8f547cc648a78a68270092e70f80",
"machineSpec": "64C500G"
}
]
}
状态码
请参考 状态码
错误码
请参考 错误码
