首页 微服务引擎MSE API参考指南 API目录 注册配置中心 Nacos服务 GetServiceListeners - 获取nacos服务监听者

GetServiceListeners - 获取nacos服务监听者

获取目标服务的监听者列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 访问级别 资源类型 条件关键字 关联操作
mse:GetServiceListeners Read
    全部资源

请求参数

名称 类型 必填 描述 示例值
ServiceName string

查询指定的服务名信息。

zeekr-orderboss
GroupName string

服务所在的分组。

WEB_GROUP
NamespaceId string

服务所在的 namespace。

ddaf8f12-****-b1c1-86e7c72e266b
ClusterName string

服务所属集群名字。

说明 此处集群为nacos服务中的概念,非MSE集群。
DEFAULT
HasIpCount string

保留字段。

none
ClusterId 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:中文
  • en:英文
zh

返回参数

名称 类型 描述 示例值
object

数据结构。

Data array

返回结果。

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:请求成功。
  • false:请求失败。
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 code 错误码 错误信息 描述
400 duplicatedClusterAliasName duplicated cluster alias name 实例名称已重复,请换一个
400 illegalRequest illegal request:%s 非法请求:%s
400 invalidParameter parameter error:%s 请求入参异常:%s
403 NoPermission You are not authorized to perform this operation. 没有权限使用此接口
404 clusterNotFound cluster not found 找不到此集群
500 systemError system error 系统开小差了,请稍后重试
500 regcenterError register center error:%s 注册配置中心请求错误:%s

访问错误中心查看更多错误码。

阿里云首页 微服务引擎 相关技术圈