ListListenersByConfig - Microservices Engine - Alibaba Cloud ドキュメントセンター

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

操作説明

説明

現在の 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	任意	パラメータは廃止されました。入力する必要はありません。	{\\"appGroup\\":\\"emas-zfive_prehost\\",\\"appName\\":\\"emas-zfive\\",\\"appStage\\":\\"PRE_PUBLISH\\",\\"appUnit\\":\\"\\",\\"bucId\\":\\"225902\\",\\"bucName\\":\\"Wireless\\",\\"provider\\":\\"aliyun\\"}
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	任意	カナリールールアイテム
GrayRuleType	string	任意	カナリールールタイプ
GrayRuleName	string	任意	カナリーバージョンの名前。
GrayRule	string	任意	カナリーリリースルール。 Beta リリースの場合、このパラメーターに 1 つ以上のクライアント IP アドレスを指定できます。複数の IP アドレスはカンマ (,) で区切る必要があります。タグベースのカナリーリリースの場合、値は「タグ名 = タグ値」のフォーマットになります。複数のタグ値はカンマ (,) で区切る必要があります。
GrayRulePriority	integer	任意	カナリーバージョンの優先順位。
AcceptLanguage	string	任意	レスポンスの言語。有効な値: zh: 中国語 en: For more information, see Install the ack-onepilot component for an ACK cluster. ja: 詳細については、「ACK クラスタに ack-onepilot コンポーネントをインストールする」をご参照ください。	zh

レスポンスフィールド

パラメーター	型	説明	例
	object	データ構造。
HttpCode	string	HTTP ステータスコード。	202
TotalCount	integer	カウント。	7
Listeners	array	リスナーに関する情報。
	object	データ構造。
Ip	string	IPアドレス	1.1.1.1
Md5	string	検証文字列。	23sdfdf
Status	string	ステータス	beta
Labels	object	リスナーのラベル。
	string	ラベルのキーと値のペア。
Version	string	リスナーの現在のバージョン。有効な値: gray と normal。	gray
MatchRuleName	string	現在のリスナーに一致するカナリルールの名前
MatchRuleType	string	一致したカナリアルールの種類
RequestId	string	リクエスト ID。	75E1442F-11EC-567A-9CF0-5A36F7904F39
Message	string	レスポンスメッセージ。	success
PageSize	integer	1ページあたりに返されるエントリの数。	10
PageNumber	integer	返されるページ番号。	2
ErrorCode	string	エラーコード。	mse-100-000
Success	boolean	Indicates whether the request was successful. Valid values: リクエストが成功したかどうかを示します。有効な値： `データタグ="code">true`: リクエストは成功しました。 `data-tag="code">false`: リクエストは失敗しました。	true

例

成功レスポンス

JSONJSON

{
  "HttpCode": "202",
  "TotalCount": 7,
  "Listeners": [
    {
      "Ip": "1.1.1.1",
      "Md5": "23sdfdf",
      "Status": "beta",
      "Labels": {
        "key": ""
      },
      "Version": "gray",
      "MatchRuleName": "",
      "MatchRuleType": ""
    }
  ],
  "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

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

変更履歴

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