查询Nacos服务集群实例
接口功能介绍
查询Nacos服务集群实例列表
接口约束
无
URI
GET /v1/nacos/service/getClusterInstances
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
instanceId | 是 | String | 实例ID | String | |
namespaceId | 否 | String | 命名空间ID,public命名空间id为空 | String | |
serviceName | 是 | String | 服务名 | String | |
groupName | 是 | String | Group ID | String | |
clusterName | 否 | String | 集合名称 | String | |
pageNum | 否 | Integer | 页码 | 1 | |
pageSize | 否 | Integer | 每页数量 | 1 |
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池 ID | d8bbd132b53a11e9b0e40242ac110002 |
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(2000成功,5000系统错误,18xxxx业务错误) | 1000 | |
error | String | 业务错误码,RCC_statusCode | RCC_1000 | |
message | String | 返回结果描述 | invalid param | |
returnObj | Object | 返回数据体 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
count | Integer | 数量 | 10 | |
list | Array of Objects | 集合 | obj |
表 obj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
instanceId | String | 注册的实例ID | String | |
port | String | 端口 | String | |
weight | Integer | 权重 | 1 | |
healthy | Boolean | 是否健康 | true | |
enabled | Boolean | 是否上线 | true | |
ephemeral | Boolean | 心是否临时实例 | true | |
clusterName | String | 集合名 | String | |
serviceName | String | 服务名 | String | |
instanceHeartBeatInterval | Boolean | 使用IPV4心跳检查周期 | true | |
metadata | String | 元数据 | {} | |
ipDeleteTimeout | Integer | 实例超时删除时间 | 1 | |
instanceHeartBeatTimeOut | Integer | 心跳检查超时时间 | 1 | |
instanceIdGenerator | String | 实例ID生成器 | simple |
枚举参数
无
请求示例
请求url
http://EndPoint/v1/nacos/service/getClustersInstance?namespaceId=091d059f-2693-42d3-b2cc-e2f63694f937&instanceId=812275248060695552&serviceName=s1&groupName=g1&clusterName=DEFAULT&pageNo=1&pageSize=10
请求头header
{"regionId": "d8bbd132b53a11e9b0e40242ac110002"}
请求体body
无
响应示例
{"returnObj": {"count":0,"list":[{"instanceId":"String","port":"String","weight":0,"healthy":true,"enabled":true,"ephemeral":true,"clusterName":"String","serviceName":"String","instanceHeartBeatInterval":true,"ipDeleteTimeout":0,"instanceHeartBeatTimeOut":0,"instanceIdGenerator":"String","metadata":{}}]},"error": "","message": "SUCCESS","statusCode": 2000}