ListListeners - - Alibaba Cloud ドキュメントセンター

Gateway Load Balancer のリスナーをクエリします。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

gwlb:ListListeners

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	タイプ	必須 / 任意	説明	例
ListenerIds	array	任意	リスナー ID。最大 20 個のリスナー ID を指定できます。
	string	任意	リスナー ID。	lsn-w3t3vpgjj12b2i****
LoadBalancerIds	array	任意	Gateway Load Balancer (GWLB) インスタンスの ID。最大 20 個のインスタンス ID を指定できます。
	string	任意	Gateway Load Balancer (GWLB) インスタンスの ID。	gwlb-rbtjolkkbudmrr****
NextToken	string	任意	次のクエリに使用されるトークン。有効な値： [NextToken] が空の場合、後続のクエリは実行されません。 [NextToken] に値が返された場合、その値は次のクエリに使用されるトークンです。	d209f4e63ec942c967c50c888a13****
MaxResults	integer	任意	各ページに返すエントリの数。有効な値：1 ～ 1000。デフォルト値：20。	20
Tag	array<object>	任意	タグ。呼び出しごとに最大 20 個のタグを指定できます。
	object	任意	タグ。
Key	string	任意	タグキー。タグキーは空の文字列にすることはできません。タグキーは最大 128 文字で、`aliyun` または `acs:` で始めることはできません。タグキーには `http://` または `https://` を含めることはできません。	tagKey
Value	string	任意	タグ値。タグ値は最大 256 文字で、`http://` または `https://` を含めることはできません。	tagValue
Skip	integer	任意	ページングクエリでスキップするエントリの数。	10

レスポンスパラメーター

パラメーター	タイプ	説明	例
	object	返されたデータ。
Listeners	array<object>	Gateway Load Balancer (GWLB) インスタンスのリスナーのリスト。
	object	リスナーに関する情報。
ListenerDescription	string	リスナーの説明。	listener-description
ListenerId	string	リスナー ID。	lsn-vu7folhh5ntm8u****
ListenerStatus	string	リスナーのステータス。有効な値： [Provisioning]：リスナーは作成中です。 [Running]：リスナーは実行中です。 [Configuring]：リスナーは構成中です。 [Deleting]：リスナーは削除中です。	Running
LoadBalancerId	string	Gateway Load Balancer (GWLB) インスタンスの ID。	gwlb-uf6hbeh795xlqln7g****
ServerGroupId	string	サーバーグループ ID。	sgp-5yapcb422i51ru****
TcpIdleTimeout	integer	アイドル状態の TCP 接続のタイムアウト期間。	350
Tags	array<object>	タグ。
	object	タグです。
Key	string	タグキー。	testKey
Value	string	タグ値。	testValue
MaxResults	integer	各ページに返されるエントリの数。有効な値：1 ～ 1000。デフォルト値：20。	20
NextToken	string	次のクエリに使用されるトークン。有効な値： [NextToken] が空の場合、後続のクエリは実行されません。 [NextToken] に値が返された場合、その値は次のクエリに使用されるトークンです。	5c281c0a0d6bfb6355ed088c2108aca8e0b5e8707e68****
RequestId	string	リクエスト ID。	7DBFC67C-A272-5952-8287-6C3EBE4E04D9
TotalCount	integer	エントリの総数。	8

例

成功レスポンス

JSONJSON

{
  "Listeners": [
    {
      "ListenerDescription": "listener-description",
      "ListenerId": "lsn-vu7folhh5ntm8u****",
      "ListenerStatus": "Running",
      "LoadBalancerId": "gwlb-uf6hbeh795xlqln7g****",
      "ServerGroupId": "sgp-5yapcb422i51ru****",
      "TcpIdleTimeout": 350,
      "Tags": [
        {
          "Key": "testKey",
          "Value": "testValue"
        }
      ]
    }
  ],
  "MaxResults": 20,
  "NextToken": "5c281c0a0d6bfb6355ed088c2108aca8e0b5e8707e68****",
  "RequestId": "7DBFC67C-A272-5952-8287-6C3EBE4E04D9",
  "TotalCount": 8
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	MissingParam.TagKey	The param of TagKey is missing.
400	DuplicatedParam.TagKey	The param of %s is duplicated.

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

変更履歴

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