获取目标服务的监听者列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
mse:GetServiceListeners |
get |
*Cluster
*EngineNamespace
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ServiceName |
string |
是 |
查询指定的服务名信息。 |
zeekr-orderboss |
| GroupName |
string |
是 |
服务所在的分组。 |
WEB_GROUP |
| NamespaceId |
string |
是 |
服务所在的 namespace。 |
ddaf8f12-****-b1c1-86e7c72e266b |
| ClusterName |
string |
否 |
服务所属集群名字。 说明
此处集群为 nacos 服务中的概念,非 MSE 集群。 |
DEFAULT |
| HasIpCount |
string |
否 |
保留字段。 |
none |
ClusterId
deprecated
|
string |
否 |
待查询服务所属的 MSE 集群 ID。 说明
InstanceId 与 ClusterId 其中一个必填。 |
mse-09k1q11**** |
| InstanceId |
string |
否 |
当前查询服务的集群 ID。 说明
InstanceId 与 ClusterId 其中一个必填。 |
mse_prepaid_public_cn-tl32odtt20j |
| PageNum |
integer |
否 |
查询第几页。 |
1 |
| PageSize |
integer |
否 |
每页展示条数。 |
10 |
| RegionId |
string |
否 |
地域 ID。 |
cn-hangzhou |
| RequestPars |
string |
否 |
扩展请求参数,JSON 格式。 |
{} |
| AcceptLanguage |
string |
否 |
返回信息的语言类型:
|
zh |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
数据结构。 |
||
| Data |
array<object> |
返回结果。 |
|
|
object |
数据概览。 |
||
| Addr |
string |
监听者的地址。 |
119.23.84.102 |
| Agent |
string |
监听者客户端版本。 |
Nacos-Java-Client:v2.1.1 |
| App |
string |
监听者的应用名称。 |
app |
| IP |
string |
被监听服务的 IP 地址。 |
172.16.1.5 |
| Port |
string |
被监听服务的端口号。 |
8080 |
| NamespaceId |
string |
命名空间 ID。 |
0ba53825-b183-414f-a6a0-288e4f1c467e |
| ServiceName |
string |
被监听服务的名称。 |
zeekr-orderboss |
| Cluster |
string |
被监听服务所属集群名字。 |
DEFAULT |
| PageNumber |
integer |
页码。 |
1 |
| TotalCount |
integer |
查询到的监听者数量。 |
2 |
| PageSize |
integer |
每页行数。 |
10 |
| Success |
boolean |
请求结果,取值如下:
|
true |
| Message |
string |
返回信息。
|
success |
| RequestId |
string |
请求 ID。 |
54973C90-F379-4372-9AA5-053A3F7**** |
| ErrorCode |
string |
错误码。 |
mse-100-000 |
| HttpCode |
string |
HTTP 状态码。 |
202 |
示例
正常返回示例
JSON格式
{
"Data": [
{
"Addr": "119.23.84.102",
"Agent": "Nacos-Java-Client:v2.1.1",
"App": "app",
"IP": "172.16.1.5",
"Port": "8080",
"NamespaceId": "0ba53825-b183-414f-a6a0-288e4f1c467e",
"ServiceName": "zeekr-orderboss",
"Cluster": "DEFAULT"
}
],
"PageNumber": 1,
"TotalCount": 2,
"PageSize": 10,
"Success": true,
"Message": "success",
"RequestId": "54973C90-F379-4372-9AA5-053A3F7****",
"ErrorCode": "mse-100-000",
"HttpCode": "202"
}
错误码
|
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 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。