接口功能介绍
查询租户的缓存redis集群节点信息。。
接口约束
无
URI
GET /v1/instanceManageMgrServant/describeClusterMemberInfo
路径参数 无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
prodInstId | 是 | String | 实例ID | 873894303586321408 |
请求参数
请求头header参数 无
请求体body参数 无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 响应状态码,取值范围:800 成功,900 失败 | 800 | |
message | String | 响应信息 | success | |
returnObj | Object | 返回数据对象,数据见returnObj |
表 returnObj | 参数 | 参数类型 | 说明 | 示例 | 下级对象 | | --------- | ------- | ------- | ------- | ------- | | total | Integer | 响应码描述 | 4 | | | rows | Array of Objects | 返回redis集群数据集,数据见redisSet | | |
表 redisSet | 参数 | 参数类型 | 说明 | 示例 | 下级对象 | | --------- | ------- | ------- | ------- | ------- | | redisSetName | String | redis集群名 | redisSet_865194359228728320 | | | RedisSetInfo | String | redis集群节点信息 | redisSet_865194359228728320_1100020&100165 | | | lastestTime | String | 更新时间戳 | 1660902632067 | | | isRWsep | String | 是否读写分离 | false | | | nodes | Array of Objects | redis节点集合,数据见RedisNode | | RedisNode |
表 RedisNode: | 参数 | 参数类型 | 说明 | 示例 | 下级对象 | | --------- | ------- | ------- | ------- | ------- | | masterName | String | 主节点名称 | master0 | | | startSlot | String | 开始槽位 | 0 | | | endSlot | String | 结束槽位 | 4095 | | | connUrl | String | 连接地址 | 10.50.208.8:20452 | | | idc | String | 暂无描述 | null | | | status | String | 节点状态 | CACHE.COMM.STATUS | | | enabled | Boolean | 是否可用状态 | true | | | slaveNodes | Array of Objects | 从节点数组,数据见SlaveNode | | SlaveNode | | standbyUrl | String | 守护地址 | 10.50.208.9:25436 | | | vpcUrl | String | vpc连接地址 | 10.50.208.7:25436 | |
表 SlaveNode: | 参数 | 参数类型 | 说明 | 示例 | 下级对象 | | --------- | ------- | ------- | ------- | ------- | | slaveName | String | redis从节点名称 | snode1 | snode1 | | connUrl | String | 连接地址 | 10.50.208.9:25436 | | | idc | String | 暂无描述 | null | | | status | String | 节点状态 | 1 | | | enabled | String | 是否可用状态 | true | | | standbyUrl | String | 守护地址 | null | | | vpcUrl | String | 从节点vpc连接地址 | 10.50.208.9:25436 | |
枚举参数
参数名 type | 枚举值 | 类型 | 说明 | | --------- | ------- | ------- | | 1 | Integer | 经典集群主备版。 | | 2 | Integer | 经典主备版。 | | 3 | Integer | 经典单机版。 | | 5 | Integer | 基础Cluster主备版。 | | 6 | Integer | 基础Cluster单机版。 |
请求示例
请求url
GET https://dcs2-global.ctapi.ctyun.cn/v1/instanceManageMgrServant/describeClusterMemberInfo?prodInstId=873894303586321408
请求头header
{
"regionId":"921d904cca2211e99aa20242ac110006"
}
请求体body
无
响应示例
{
"code": "core.ok",
"returnObj": {
"total": 1,
"rows": [
{
"redisSetName": "redisSet_865194359228728320",
"redisSetInfo": "redisSet_865194359228728320_1100020&100165",
"lastestTime": "1660902632067",
"isRWsep": false,
"nodes": [
{
"masterName": "master0",
"startSlot": "0",
"endSlot": "4095",
"connUrl": "10.50.208.8:20452",
"idc": null,
"status": "CACHE.COMM.STATUS",
"enabled": true,
"slaveNodes": [
{
"slaveName": "snode1",
"connUrl": "10.50.208.7:20452",
"idc": null,
"status": "1",
"enabled": true,
"standbyUrl": null,
"vpcUrl": "10.50.208.7:20452"
}
],
"standbyUrl": "10.50.208.7:20452",
"vpcUrl": "10.50.208.8:20452"
}
]
}
]
},
"message": "success",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码