全部產品
Search
文件中心

Microservices Engine:ListListenersByConfig - 查詢配置監聽者

更新時間:Jun 01, 2026

根據配置資訊查詢監聽者。

介面說明

說明

當前的 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

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情