すべてのプロダクト
Search

このプロダクト

    Microservices Engine:ListListenersByConfig

    ドキュメントセンター

    Microservices Engine:ListListenersByConfig

    最終更新日:Aug 21, 2026

    構成情報に基づいてリスナーを照会します。

    操作説明

    説明

    現在の OpenAPI は Nacos-SDK API ではありません。Nacos-SDK API の詳細については、公式ドキュメント を参照してください。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    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<object>

    任意

    追加のカナリアリリースルールのリスト。リスナーのマッチングを実行する際、追加のカナリアリリースルールが既存のルールとマージされてマッチングに使用されます。

    object

    任意

    カナリアリリースルール項目。

    GrayRuleType

    string

    任意

    カナリアリリースルールのタイプ。

    Tags
    GrayRuleName

    string

    任意

    カナリアリリースバージョンの名前。

    test
    GrayRule

    string

    任意

    カナリアリリールール。Beta カナリアリリースの場合、このフィールドにはカナリアリリースクライアントの IP アドレスがカンマ区切りで含まれます。タグベースのカナリアリリースの場合、このフィールドには tag_name=tag_value が含まれ、複数のタグ値はカンマで区切られます。

    127.0.0.1
    GrayRulePriority

    integer

    任意

    カナリアリリースバージョンの優先度。

    100
    AcceptLanguage

    string

    任意

    応答の言語。有効な値:

    • zh: 中国語。

    • en: 英語。

    zh

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    データ構造。

    HttpCode

    string

    HTTP 状態コード。

    202
    TotalCount

    integer

    合計数。

    7
    Listeners

    array<object>

    リスナー情報のリスト。

    array<object>

    データ構造。

    Ip

    string

    IP。

    1.1.1.1
    Md5

    string

    チェックサムの文字列。

    23sdfdf
    Status

    string

    プッシュが成功したかどうかを示します。

    true
    Labels

    object

    リスナーのラベルのリスト。

    string

    ラベルのキーと値のペア。

    a=b
    Version

    string

    リスナーの現在のバージョン。有効な値: gray (カナリアリリースバージョン)、normal (本番バージョン)。

    gray
    MatchRuleName

    string

    現在のリスナーが一致したカナリアリリースルールの名前。

    一致したカナリアリリースルールの名前
    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

    例

    成功レスポンス

    JSONJSON

    {
  "HttpCode": "202",
  "TotalCount": 7,
  "Listeners": [
    {
      "Ip": "1.1.1.1",
      "Md5": "23sdfdf",
      "Status": "true",
      "Labels": {
        "key": "a=b"
      },
      "Version": "gray",
      "MatchRuleName": "Matched canary rule name",
      "MatchRuleType": "Beta"
    }
  ],
  "RequestId": "75E1442F-11EC-567A-9CF0-5A36F7904F39",
  "Message": "success",
  "PageSize": 10,
  "PageNumber": 2,
  "ErrorCode": "mse-100-000",
  "Success": true
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 IllegalRequest Invalid request:%s
    400 InvalidParameter Parameter error:%s
    500 InternalError Console error. Try again later:%s
    403 NoPermission You are not authorized to perform this operation:%s
    404 NotFound Not found:%s

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。