查询Nacos服务列表
接口功能介绍
查询Nacos服务列表
接口约束
无
URI
GET /v1/nacos/service/list
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
instanceId | 是 | String | 实例ID | String | |
namespaceId | 否 | String | 命名空间ID,public命名空间id为空 | String | |
serviceNameParam | 否 | String | 服务名 | String | |
groupNameParam | 否 | String | 分组 ID | String | |
hasIpCount | 否 | Boolean | 是否隐藏空服务 | true | |
withInstances | 否 | Boolean | 是否返回实例信息 | false | |
pageNum | 否 | Integer | 页号 | 1 | |
pageSize | 否 | Integer | 每页数量 | 10 |
请求参数
请求头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
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
pageNo | Integer | 页号 | 1 | |
count | Integer | 数量 | 10 | |
serviceList | Array of Objects | 数据列表 | serviceObj | |
pageSize | Integer | 每页数量 | 10 |
表 serviceObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
groupName | String | group名称 | String | |
clusterCount | Integer | cluster数量 | 1 | |
name | String | 服务名称 | String | |
ipCount | Integer | 实例数 | 1 | |
healthyInstanceCount | Integer | 健康实例数 | 1 |
枚举参数
无
请求示例
请求url
http://EndPoint/v1/nacos/service/list?namespaceId=091d059f-2693-42d3-b2cc-e2f63694f937&instanceId=812275248060695552&pageSize=10&pageNum=1&hasIpCount=false&withInstances=false
请求头header
{"regionId": "d8bbd132b53a11e9b0e40242ac110002"}
请求体body
无
响应示例
{"returnObj": {"count": 0,"serviceList": [{"name": "","groupName": "","clusterCount": 0,"ipCount": 0,"healthyInstanceCount": 0,"triggerFlag": false}],"pageNo": 0,"pageSize": 0},"error": "","message": "SUCCESS","statusCode": 2000}