查询分片集群实例的节点详情v2
更新时间 2025-10-22 18:12:11
最近更新时间: 2025-10-22 18:12:11
接口功能介绍
查询sharding集群实例的节点信息
接口约束
用户通过鉴权认证
URI
GET /DDS2/v2/openApi/describeShardingNodeDetail
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 文档数据库对外的实例标识 | 60d420bffb394************************* | |
| nodeType | 否 | String | sharding集群架构类型，可取shard，configsvr | configsvr |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| project-id | 否 | String | 项目id | 0 | |
| regionId | 是 | String | 资源池id | bb9fdb42056f11eda1610242ac110002 |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 响应码 取值范围：800为成功，900为失败 | 800 | |
| message | String | 响应信息 | 查询sharding集群节点信息成功 | |
| returnObj | Array of Objects | 返回对象 | returnObj | |
| error | String | 错误码。当接口失败时才返回具体错误编码，成功不返回或者为空。 | ||
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| node | String | 架构类型编号 | mongos-15381003 | |
| diskSize | String | 磁盘空间 | 100 | |
| memory | String | 内存空间 | 4 | |
| role | String | sharding节点类型 | Mongos | |
| alive | Integer | 节点运行状态 | 1 | |
| usedSpace | String | 使用空间 | 0 | |
| azDisplayName | String | 可用区信息 | 西北-贵州可用区2 | |
| host | String | 节点机器地址 | 10.0.2.51 | |
| prodInstId | String | 实例id | d92e279cb1*** | |
| resId | Integer | 机器id序号 | 15381003 | |
| cpuCount | Integer | cpu核数 | 2 |
枚举参数
无
请求示例
请求url
/v2/openApi/describeShardingNodeDetail?prodInstId=d92e279cb1***
请求头header
project-id=0
regionId=bb9fdb42056f11eda1610242ac110002
请求体body
无
响应示例
{
"statusCode": 800,
"message": "查询sharding集群节点信息成功",
"returnObj": [
{
"node": "sharding_shard1",
"diskSize": "100",
"memory": "4",
"role": "Shard",
"alive": -1,
"usedSpace": "0",
"azDisplayName": "",
"host": "",
"prodInstId": "d92e279cb1134793bace2e9435b26d4f",
"resId": 15381005,
"cpuCount": 2
},
{
"node": "sharding_shard2",
"diskSize": "100",
"memory": "4",
"role": "Shard",
"alive": -1,
"usedSpace": "0",
"azDisplayName": "",
"host": "",
"prodInstId": "d92e279cb1134793bace2e9435b26d4f",
"resId": 15381008,
"cpuCount": 2
},
{
"node": "sharding_configsvr",
"diskSize": "100",
"memory": "2",
"role": "ConfigServer",
"alive": -1,
"usedSpace": "0",
"azDisplayName": "",
"host": "",
"prodInstId": "d92e279cb1134793bace2e9435b26d4f",
"resId": 15381011,
"cpuCount": 1
},
{
"node": "mongos-15381003",
"diskSize": "40",
"memory": "4",
"role": "Mongos",
"alive": -1,
"usedSpace": "0",
"azDisplayName": "西北-贵州可用区2",
"host": "10.0.2.51",
"prodInstId": "d92e279cb1134793bace2e9435b26d4f",
"resId": 15381003,
"cpuCount": 2
},
{
"node": "mongos-15381004",
"diskSize": "40",
"memory": "4",
"role": "Mongos",
"alive": -1,
"usedSpace": "0",
"azDisplayName": "西北-贵州可用区2",
"host": "10.0.2.39",
"prodInstId": "d92e279cb1134793bace2e9435b26d4f",
"resId": 15381004,
"cpuCount": 2
}
]
}
状态码
请参考 状态码
错误码
请参考 错误码
