调用ListListenersByConfig查询配置监听者_微服务引擎(MSE)-阿里云帮助中心

根据配置信息查询监听者。

接口说明

说明

当前的 OpenAPI 并非是 Nacos-SDK API，Nacos-SDK API 相关内容，请参见官方文档。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

mse:ListListenersByConfig

get

*Cluster

acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}

*EngineNamespace

acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}/{#NamespaceId}

无

请求参数

名称	类型	必填	描述	示例值
RequestPars	string	否	参数弃用，无需填写	...
InstanceId	string	是	实例的 ID。	mse-cn-m7r1yurp00e
DataId	string	是	数据 ID。	zeekr-clueboss.yml
Group	string	是	分组。	prod
NamespaceId	string	否	命名空间 ID，默认为 public	aaeb4d28-c9eb-4fa2-85f5-d03ce7ee8df1
ExtGrayRules	array	否	额外的灰度规则列表，在进行 listener 匹配时会将额外的灰度规则和现有的规则合并进行匹配
	object	否	灰度规则项
GrayRuleType	string	否	灰度规则类型	Tags
GrayRuleName	string	否	灰度版本名称	test
GrayRule	string	否	灰度规则，如果是 Beta 灰度，此处是灰度的客户端的 ip，使用逗号分隔；如果是标签灰度，此处是标签名=标签值，多个标签值使用逗号分隔	127.0.0.1
GrayRulePriority	integer	否	灰度版本优先级	100
AcceptLanguage	string	否	返回信息的语言类型： zh：中文 en：英文	zh

返回参数

名称	类型	描述	示例值
	object	数据结构。
HttpCode	string	HTTP 状态码。	202
TotalCount	integer	数量。	7
Listeners	array	监听者信息。
	object	数据结构。
Ip	string	IP。	1.1.1.1
Md5	string	校验串。	23sdfdf
Status	string	是否推送成功	true
Labels	object	监听者所带的标签
	string	标签的键值对	a=b
Version	string	监听者当前的版本，gray（灰度版本）或者 nromal（正式版本）	gray
MatchRuleName	string	当前 Listener 匹配的灰度规则名称	匹配到的灰度规则的名称
MatchRuleType	string	匹配到的灰度规则的类型	Beta
RequestId	string	请求 ID。	75E1442F-11EC-567A-9CF0-5A36F7904F39
Message	string	响应信息。	success
PageSize	integer	当前页的大小。	10
PageNumber	integer	当前页码。	2
ErrorCode	string	错误码。	mse-100-000
Success	boolean	请求结果，取值如下： `true`：请求成功。 `false`：请求失败。	true

示例

正常返回示例

JSON格式

{
  "HttpCode": "202",
  "TotalCount": 7,
  "Listeners": [
    {
      "Ip": "1.1.1.1",
      "Md5": "23sdfdf",
      "Status": "true",
      "Labels": {
        "key": "a=b"
      },
      "Version": "gray",
      "MatchRuleName": "匹配到的灰度规则的名称",
      "MatchRuleType": "Beta"
    }
  ],
  "RequestId": "75E1442F-11EC-567A-9CF0-5A36F7904F39",
  "Message": "success",
  "PageSize": 10,
  "PageNumber": 2,
  "ErrorCode": "mse-100-000",
  "Success": true
}

错误码

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

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

变更历史

更多信息，参考变更详情。