查询Nacos服务集群
接口功能介绍
查询Nacos服务集群集合
接口约束
无
URI
GET /v1/nacos/service/getClusters
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
instanceId | 是 | String | 实例ID | String | |
namespaceId | 否 | String | 命名空间ID,public命名空间id为空 | String | |
serviceName | 是 | String | 服务名 | String | |
groupName | 是 | String | Group ID | 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
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
service | Object | 服务 | serviceObj | |
clusters | Array of Objects | 集合 | clusterObj |
表 serviceObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
name | String | 服务名 | String | |
groupName | String | 分组名 | String | |
protectThreshold | Double | 保护阈值 | 0 | |
metadata | Map of String | 元数据 | {} |
表 clusterObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
serviceName | String | 服务名 | String | |
name | String | 集合名 | String | |
healthChecker | Map of String | 心跳检查 | {} | |
defaultPort | Integer | 默认端口 | 1 | |
defaultCheckPort | Integer | 默认检查端口 | 1 | |
useIPPort4Check | Boolean | 使用IPV4检查 | true | |
metadata | Map of String | 元数据 | {} |
枚举参数
无
请求示例
请求url
http://EndPoint/v1/nacos/service/getClusters?namespaceId=091d059f-2693-42d3-b2cc-e2f63694f937&instanceId=812275248060695552&serviceName=s1&groupName=g1
请求头header
{"regionId": "d8bbd132b53a11e9b0e40242ac110002"}
请求体body
无
响应示例
{"returnObj": {"service": {"name": "GENERATE_SERVICE_5","groupName": "DEFAULT_GROUP","protectThreshold": 0.0,"selector": {"type": "none","contextType": "NONE"},"metadata": {}},"clusters": [{"serviceName": "DEFAULT_GROUP@@GENERATE_SERVICE_5","name": "DEFAULT","healthChecker": {"type": "TCP"},"defaultPort": 80,"defaultCheckPort": 80,"useIPPort4Check": true,"metadata": {}}]},"error": "","message": "SUCCESS","statusCode": 2000}