查询Nacos服务实例列表
接口功能介绍
查询Nacos服务实例列表
接口约束
无
URI
GET /v1/nacos/service/getInstanceList
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
instanceId | 是 | String | 实例ID | String | |
namespaceId | 否 | String | 命名空间ID,public命名空间id为空 | String | |
serviceName | 是 | String | 服务名 | String | |
groupName | 是 | String | Group ID | String | |
clientIP | 否 | String | 实例IP | String | |
clusters | 否 | String | cluster名称 | String | |
healthyOnly | 否 | Boolean | 只返回健康实例 | true | |
app | 否 | String | 所属应用 | String |
请求参数
请求头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
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
name | String | 服务名称 | Integer | |
groupName | String | Group | String | |
clusters | Array of Strings | cluster | [] | |
hosts | Array of Objects | 实例列表 | insObj | |
lastRefTime | Long | 最后刷新时间 | 0 | |
valid | Boolean | 是否有效 |
表 insObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
instanceHeartBeatInterval | Integer | 实例心跳间隔 | 1 | |
ipDeleteTimeout | Integer | 实例非健康状态删除时间 | 1 | |
instanceHeartBeatTimeOut | Integer | 实例心跳超时时间 | 1 | |
instanceId | String | 实例 ID(此处表示注册到nacos的实例的ID) | String | |
ip | String | 健康IP | String | |
port | String | 端口 | 8080 | |
weight | Integer | 权重 | 100 | |
healthy | Boolean | 是否健康 | true | |
enabled | Boolean | 是否上线 | true | |
ephemeral | Boolean | 是否临时实例 | true | |
clusterName | String | cluster名称 | String | |
serviceName | String | 服务名 | String | |
metadata | String | 元数据 | {} |
枚举参数
无
请求示例
请求url
http://EndPoint/v1/nacos/service/getInstanceList?namespaceId=091d059f-2693-42d3-b2cc-e2f63694f937&instanceId=812275248060695552&serviceName=s1&groupName=g1
请求头header
{"regionId": "d8bbd132b53a11e9b0e40242ac110002"}
请求体body
无
响应示例
{"returnObj": {"name": "","groupName": "","clusters": "","cacheMillis": 0,"hosts": [{"instanceHeartBeatInterval": 0,"ipDeleteTimeout": 0,"instanceHeartBeatTimeOut": 0,"instanceId": "","ip": "","port": 0,"weight": 0.0,"healthy": false,"enabled": false,"ephemeral": false,"clusterName": "","serviceName": "","metadata": {"": ""}}],"lastRefTime": 0,"checksum": "","allIPs": false,"reachProtectionThreshold": false,"valid": false},"error": "","message": "SUCCESS","statusCode": 2000}