查询实例拓扑结构
更新时间 2025-10-17 14:30:08
最近更新时间: 2025-10-17 14:30:08
接口功能介绍
查询实例拓扑结构
接口约束
无
URI
GET /v1/instanceManageMgrServant/describeLogicInstanceTopology
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 实例ID | 873894303586321408 |
请求参数
请求头header参数 无
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| code | String | 响应码描述 | core.ok | |
| statusCode | Integer | 响应状态码，取值范围：800 成功，900 失败 | 800 | |
| message | String | 响应信息 | success | |
| returnObj | Array of Objects | 返回数据对象，数据见returnObj | returnObj | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| redisNodes | String | redis节点集合，见RedisNode | redisNodes | |
| accessNodes | String | 接入机节点集合，见AccessNode | accessNodes | |
| 表 redisNodes |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| connUrl | String | 连接地址 | 10.50.208.8:20324 | |
| startSlot | String | 开始槽位 | 0 | |
| endSlot | String | 结束槽位 | 4095 | |
| vpcUrl | String | vpc连接地址 | 10.50.208.8:20324 | |
| standbyUrl | String | 备节点Url | 10.50.208.9:20324 | |
| status | String | 节点状态，CACHE.COMM.STATUS：分组正常状态；CACHE.DIAT.PREP：扩容数据准备；CACHE.DIAT.PROCESS：执行扩容数据；CACHE.DIAT.DEL：删除；CACHE.PROB.SWIT：故障待切换； | CACHE.COMM.STATUS | |
| masterName | String | 主节点名称 | master0 | |
| slaves | String | 从节点集合 | slaves | |
| 表 accessNodes |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| clientConnNum | Integer | 客户端连接数 | 5 | |
| clientMaxConnNum | Integer | 接入机最大并发连接数 | 10000 | |
| connNumPerRedis | String | Redis节点每秒连接数 | 50 | |
| connUrl | String | 连接地址 | 10.50.208.9:31046 | |
| proxyName | String | 代理名称 | access_864210898632311808_1 | |
| vpcUrl | String | vpc连接地址 | 10.50.208.9:31046 | |
| 表 slaves |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| connUrl | String | 连接地址 | 10.50.208.9:20324 | |
| slaveName | String | redis从节点名称 | snode1 | |
| vpcUrl | String | vpc连接地址 | 10.50.208.9:20324 | |
| standbyUrl | String | 守护地址 | null | |
| status | String | redis运行状态,固定1 | 1 |
枚举参数
无
请求示例
请求url
GET https://dcs2-global.ctapi.ctyun.cn/v1/instanceManageMgrServant/describeLogicInstanceTopology?prodInstId=864210898632311808
请求头header
{}
请求体body
1
响应示例
{
"code": "core.ok",
"returnObj": {
"redisNodes": [{
"connUrl": "10.50.208.8:20324",
"startSlot": "0",
"endSlot": "4095",
"vpcUrl": "10.50.208.8:20324",
"standbyUrl": "10.50.208.9:20324",
"status": "CACHE.COMM.STATUS",
"masterName": "master0",
"slaves": [{
"connUrl": "10.50.208.9:20324",
"slaveName": "snode1",
"vpcUrl": "10.50.208.9:20324",
"standbyUrl": null,
"status": "1"
}
]
}, {
"connUrl": "10.50.208.8:20260",
"startSlot": "12288",
"endSlot": "16383",
"vpcUrl": "10.50.208.8:20260",
"standbyUrl": "10.50.208.9:20260",
"status": "CACHE.COMM.STATUS",
"masterName": "master3",
"slaves": [{
"connUrl": "10.50.208.9:20260",
"slaveName": "snode1",
"vpcUrl": "10.50.208.9:20260",
"standbyUrl": null,
"status": "1"
}
]
}
],
"accessNodes": [{
"clientConnNum": 5,
"clientMaxConnNum": 10000,
"connNumPerRedis": "50",
"connUrl": "10.50.208.9:31046",
"proxyName": "access_864210898632311808_1",
"vpcUrl": "10.50.208.9:31046"
}, {
"clientConnNum": 5,
"clientMaxConnNum": 10000,
"connNumPerRedis": "50",
"connUrl": "10.50.208.8:31046",
"proxyName": "access_864210898632311808_2",
"vpcUrl": "10.50.208.8:31046"
}
]
},
"message": "success",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
