查询Nacos服务的集群列表。
接口说明
当前的 OpenAPI 并非是 Nacos-SDK API，Nacos-SDK API 相关内容，请参见官方文档。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| PageNum |
integer |
是 |
页码。 |
1 |
| PageSize |
integer |
是 |
每页展示实例数。 |
10 |
ClusterId
deprecated
|
string |
否 |
MSE 集群 ID。 说明
此处的集群与 nacos 服务下的集群概念不同，勿混淆。 |
mse-09k1xxxx |
| ServiceName |
string |
否 |
服务名称。 |
nacos.test.3 |
| GroupName |
string |
否 |
分组名称，默认为 DEFAULT_GROUP |
DEFAULT_GROUP |
| NamespaceId |
string |
否 |
命名空间 ID，默认为 public |
12233**** |
| ClusterName |
string |
否 |
nacos 服务集群名 |
qewr |
| InstanceId |
string |
否 |
实例 ID。 |
mse_prepaid_public_cn-tl32a6**** |
| AcceptLanguage |
string |
否 |
返回信息的语言类型：
|
zh |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
数据结构。 |
||
| Message |
string |
信息。 |
The request is successfully processed. |
| RequestId |
string |
请求 ID。 |
52BA6DA6-A702-4362-A32F-DFF79655**** |
| Data |
object |
数据概览。 |
|
| ProtectThreshold |
number |
保护阈值。 |
0 |
| GroupName |
string |
服务所属服务组。 |
DEFAULT_GROUP |
| Clusters |
array<object> |
集群信息。 |
|
|
array<object> |
数据结构。 |
||
| DefaultCheckPort |
integer |
默认检查端口。 |
80 |
| HealthCheckerType |
string |
健康检查类型。 |
tcp |
| UseIPPort4Check |
boolean |
服务端是否主动发起端到端健康状态检查，当服务为非临时服务时此值有效。 |
true |
| ServiceName |
string |
全量服务名。 |
DEFAULT_GROUP@@nacos.test.3 |
| Name |
string |
集群名称。 |
test |
| DefaultPort |
integer |
默认端口。 |
80 |
| Metadata |
object |
集群元数据。 |
111 |
| Name |
string |
服务名称。 |
nacos.test.3 |
| SelectorType |
string |
选举模式。 |
none |
| Metadata |
object |
服务元数据。 |
111 |
| Ephemeral |
boolean |
是否临时节点，取值如下：
|
true |
| Source |
string |
服务类型，取值如下：
|
console |
| AppDetail |
object |
服务类型为服务治理注册时，服务所关联的服务治理应用信息。 |
|
| AppId |
string |
服务治理应用 id。 |
hkhon1po62@904cba2c0xxxxxx |
| AppName |
string |
服务治理应用名。 |
spring-cloud-b |
| Port |
integer |
服务治理应用端口。 |
6001 |
| CheckType |
string |
健康检查协议，取值如下：
|
tcp |
| CheckPath |
string |
健康检查路径（健康检查类型为 http 时携带）。 |
/health |
| CheckTimeout |
integer |
健康检查响应超时时间，单位：秒。 |
5 |
| CheckInternal |
integer |
健康检查间隔，单位：秒。 |
2 |
| HealthyCheckTimes |
integer |
健康检查健康阈值，指实例从不健康变为健康过程中健康探测重试次数。 |
2 |
| UnhealthyCheckTimes |
integer |
健康检查不健康阈值，指实例从健康变为不健康过程中健康探测重试次数。 |
2 |
| ErrorCode |
string |
错误码。 |
mse-100-000 |
| Success |
boolean |
请求结果，取值如下：
|
true |
| HttpCode |
string |
HTTP 状态码。 |
200 |
示例
正常返回示例
JSON格式
{
"Message": "The request is successfully processed.",
"RequestId": "52BA6DA6-A702-4362-A32F-DFF79655****",
"Data": {
"ProtectThreshold": 0,
"GroupName": "DEFAULT_GROUP",
"Clusters": [
{
"DefaultCheckPort": 80,
"HealthCheckerType": "tcp",
"UseIPPort4Check": true,
"ServiceName": "DEFAULT_GROUP@@nacos.test.3",
"Name": "test",
"DefaultPort": 80,
"Metadata": 111
}
],
"Name": "nacos.test.3",
"SelectorType": "none",
"Metadata": 111,
"Ephemeral": true,
"Source": "console",
"AppDetail": {
"AppId": "hkhon1po62@904cba2c0xxxxxx",
"AppName": "spring-cloud-b",
"Port": 6001,
"CheckType": "tcp",
"CheckPath": "/health",
"CheckTimeout": 5,
"CheckInternal": 2,
"HealthyCheckTimes": 2,
"UnhealthyCheckTimes": 2
}
},
"ErrorCode": "mse-100-000",
"Success": true,
"HttpCode": "200"
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | IllegalRequest | Invalid request:%s | 非法请求： %s |
| 400 | InvalidParameter | Parameter error:%s | 请求参数错误：%s |
| 500 | InternalError | Console error. Try again later:%s | 控制台错误.稍后重试：%s |
| 403 | NoPermission | You are not authorized to perform this operation:%s | 没有权限使用此接口：%s |
| 404 | NotFound | Not found:%s | 资源不存在：%s |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。