ListListenersByConfig - 查询配置监听者

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

接口说明

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
RequestParsstring

参数弃用,无需填写

...
InstanceIdstring

实例的 ID。

mse-cn-m7r1yurp00e
DataIdstring

数据 ID。

zeekr-clueboss.yml
Groupstring

分组。

prod
NamespaceIdstring

命名空间 ID,默认为 public

aaeb4d28-c9eb-4fa2-85f5-d03ce7ee8df1
ExtGrayRulesarray<object>

额外的灰度规则列表,在进行 listener 匹配时会将额外的灰度规则和现有的规则合并进行匹配

object

灰度规则项

GrayRuleTypestring

灰度规则类型

Tags
GrayRuleNamestring

灰度版本名称

test
GrayRulestring

灰度规则,如果是 Beta 灰度,此处是灰度的客户端的 ip,使用逗号分隔;如果是标签灰度,此处是 标签名=标签值,多个标签值使用逗号分隔

127.0.0.1
GrayRulePriorityinteger

灰度版本优先级

100
AcceptLanguagestring

返回信息的语言类型:

  • zh:中文
  • en:英文
zh

返回参数

名称类型描述示例值
object

数据结构。

HttpCodestring

HTTP 状态码。

202
TotalCountinteger

数量。

7
Listenersarray<object>

监听者信息。

Listenerobject

数据结构。

Ipstring

IP。

1.1.1.1
Md5string

校验串。

23sdfdf
Statusstring

是否推送成功

true
Labelsobject

监听者所带的标签

string

标签的键值对

a=b
Versionstring

监听者当前的版本,gray(灰度版本)或者 nromal(正式版本)

gray
MatchRuleNamestring

当前 Listener 匹配的灰度规则名称

匹配到的灰度规则的名称
MatchRuleTypestring

匹配到的灰度规则的类型

Beta
RequestIdstring

请求 ID。

75E1442F-11EC-567A-9CF0-5A36F7904F39
Messagestring

响应信息。

success
PageSizeinteger

当前页的大小。

10
PageNumberinteger

当前页码。

2
ErrorCodestring

错误码。

mse-100-000
Successboolean

请求结果,取值如下:

  • 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错误码错误信息描述
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

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

变更历史

变更时间变更内容概要操作
2024-11-06OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2022-03-16OpenAPI 返回结构发生变更查看变更详情