全部产品
Search

搜索本产品

    微服务引擎MSE：GetServiceListeners - 获取nacos服务监听者

    文档中心

    微服务引擎MSE：GetServiceListeners - 获取nacos服务监听者

    更新时间：Nov 20, 2024

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

    调试

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

    授权信息

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

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    mse:GetServiceListenersget
    *Cluster
    acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}
    *EngineNamespace
    acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}/{#NamespaceId}
      无
    		无

    请求参数

    名称类型必填描述示例值
    ServiceNamestring是

    查询指定的服务名信息。

    		zeekr-orderboss
    GroupNamestring是

    服务所在的分组。

    		WEB_GROUP
    NamespaceIdstring是

    服务所在的 namespace。

    		ddaf8f12-****-b1c1-86e7c72e266b
    ClusterNamestring否

    服务所属集群名字。

    说明 此处集群为 nacos 服务中的概念，非 MSE 集群。
    		DEFAULT
    HasIpCountstring否

    保留字段。

    		none
    ClusterIddeprecatedstring否

    待查询服务所属的 MSE 集群 ID。

    说明 InstanceId 与 ClusterId 其中一个必填。
    		mse-09k1q11****
    InstanceIdstring否

    当前查询服务的集群 ID。

    说明 InstanceId 与 ClusterId 其中一个必填。
    		mse_prepaid_public_cn-tl32odtt20j
    PageNuminteger否

    查询第几页。

    		1
    PageSizeinteger否

    每页展示条数。

    		10
    RegionIdstring否

    地域 ID。

    		cn-hangzhou
    RequestParsstring否

    扩展请求参数，JSON 格式。

    		{}
    AcceptLanguagestring否

    返回信息的语言类型：

    • zh：中文
    • en：英文
    		zh

    返回参数

    名称类型描述示例值
    object

    数据结构。

    Dataarray<object>

    返回结果。

    dataobject

    数据概览。

    Addrstring

    监听者的地址。

    		119.23.84.102
    Agentstring

    监听者客户端版本。

    		Nacos-Java-Client:v2.1.1
    Appstring

    监听者的应用名称。

    		app
    IPstring

    被监听服务的 IP 地址。

    		172.16.1.5
    Portstring

    被监听服务的端口号。

    		8080
    NamespaceIdstring

    命名空间 ID。

    		0ba53825-b183-414f-a6a0-288e4f1c467e
    ServiceNamestring

    被监听服务的名称。

    		zeekr-orderboss
    Clusterstring

    被监听服务所属集群名字。

    		DEFAULT
    PageNumberinteger

    页码。

    		1
    TotalCountinteger

    查询到的监听者数量。

    		2
    PageSizeinteger

    每页行数。

    		10
    Successboolean

    请求结果，取值如下：

    • true：请求成功。
    • false：请求失败。
    		true
    Messagestring

    返回信息。

    • 当请求成功时，返回成功信息。
    • 当请求失败时，返回失败原因。
    		success
    RequestIdstring

    请求 ID。

    		54973C90-F379-4372-9AA5-053A3F7****
    ErrorCodestring

    错误码。

    		mse-100-000
    HttpCodestring

    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错误码错误信息描述
    400IllegalRequestInvalid request:%s非法请求： %s
    400InvalidParameterParameter error:%s请求参数错误：%s
    403NoPermissionYou are not authorized to perform this operation:%s没有权限使用此接口：%s
    404NotFoundNot found:%s资源不存在：%s
    500InternalErrorConsole error. Try again later:%s控制台错误.稍后重试：%s

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

    变更历史

    变更时间变更内容概要操作
    2023-04-25API 内部配置变更，不影响调用查看变更详情