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

Global Accelerator (GA) インスタンスのリスナーの構成情報を照会します。

操作説明

この操作は、GA インスタンスのリスナーの構成情報を照会するために使用されます。この情報には、リスナーのルーティングタイプ、リスナーのステータス、リスナーが作成された日時を示すタイムスタンプ、およびリスナーポートが含まれます。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ga:DescribeListener

get

*Listener

acs:ga:{#regionId}:{#accountId}:listener/{#listenerId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	GA インスタンスがデプロイされているリージョンの ID。値を cn-hangzhou に設定します。	cn-hangzhou
ListenerId	string	必須	照会するリスナーの ID。	lsr-bp1bpn0kn908w4nbw****

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
Description	string	リスナーの説明。	Listener
RequestId	string	リクエストの ID。	6FEA0CF3-D3B9-43E5-A304-D217037876A8
State	string	リスナーのステータス。有効値： configuring：リスナーは設定中です。 init：リスナーは初期化中です。 updating：リスナーは更新中です。 deleting：リスナーは削除中です。	active
CreateTime	string	リスナーが作成された時刻。この値は、1970 年 1 月 1 日 00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプです。単位：ミリ秒。	1577786252000
PortRanges	array<object>	リスナーポートに関する情報。
	object	リスナーポートの詳細。
FromPort	integer	エンドポイントへのリクエストを受信および転送するために使用されるリスナーポート範囲の最初のポート。	20
ToPort	integer	エンドポイントへのリクエストを受信および転送するために使用されるリスナーポート範囲の最後のポート。	20
BackendPorts	array<object>	バックエンドポートに関する情報。
	object	バックエンドポートの詳細。
FromPort	string	バックエンドサーバーがリクエストを受信するために使用するポート範囲の最初のポート。このパラメーターは、HTTPS リスナーが設定され、リスナーポートがバックエンドサーバーのサービスポートと同じ場合にのみ返されます。	80
ToPort	string	バックエンドサーバーがリクエストを受信するために使用するポート範囲の最後のポート。	80
Certificates	array<object>	SSL 証明書。
	object	SSL 証明書。
Type	string	SSL 証明書のタイプ。 Server のみが返される場合があり、これはサーバー証明書を示します。	Server
Id	string	SSL 証明書の ID。	449****-cn-hangzhou
Protocol	string	リスナーが使用するネットワーク伝送プロトコル。有効値： tcp：TCP。 udp：UDP。 http：HTTP。 https：HTTPS。	tcp
ListenerId	string	リスナーの ID。	lsr-bp1bpn0kn908w4nbw****
ClientAffinity	string	リスナーでクライアントアフィニティが有効になっているかどうかを示します。 NONE が返された場合、クライアントアフィニティは無効です。同じクライアントからのリクエストは、異なるエンドポイントに転送される場合があります。 SOURCE_IP が返された場合、クライアントアフィニティは有効です。クライアントがステートフルアプリケーションにアクセスすると、同じクライアントからのリクエストは、ソースポートやプロトコルに関係なく、同じエンドポイントに転送されます。	SOURCE_IP
Name	string	リスナーの名前。	Listener
RelatedAcls	array<object>	リスナーに関連付けられているアクセス制御リスト (ACL) に関する情報。
	object
AclId	string	リスナーに関連付けられている ACL の ID。	123
Status	string	アクセスの制御機能が有効になっているかどうかを示します。有効値： on：有効。 off：無効。	off
AclType	string	ACL のタイプ。有効値： white：ホワイトリスト。ACL 内の IP アドレスまたは CIDR ブロックからのリクエストのみが転送されます。ホワイトリストは、特定の IP アドレスのみにアプリケーションへのアクセスを許可する場合に適しています。ホワイトリストが不適切に設定されていると、リスクが生じる可能性があります。リスナーにホワイトリストが設定されると、ホワイトリストに追加された IP アドレスからのリクエストのみがリスナーによって分散されます。ホワイトリストが有効になっているが、ACL に IP アドレスが追加されていない場合、リスナーはリクエストを転送しません。 black：ブラックリスト。ACL 内の IP アドレスまたは CIDR ブロックからのすべてのリクエストがブロックされます。ブラックリストは、特定の IP アドレスからのアプリケーションへのアクセスを拒否する場合に適しています。ブラックリストが有効になっているが、ACL に IP アドレスが追加されていない場合、リスナーはすべてのリクエストを転送します。このパラメーターは、Status の値が on の場合にのみ返されます。	white
AcceleratorId	string	GA インスタンスの ID。	ga-bp1odcab8tmno0hdq****
ProxyProtocol `deprecated`	boolean	クライアント IP アドレスの保持機能が有効になっているかどうかを示します。有効値： true：バックエンドサービスを介してクライアントのソース IP アドレスを表示できます。 false	false
XForwardedForConfig	object	`XForward` ヘッダーの設定。
XForwardedForGaIdEnabled	boolean	`GA-ID` ヘッダーを使用して GA インスタンスの ID を取得するかどうかを示します。有効値： true false 説明このパラメーターは、HTTP および HTTPS リスナーに対してのみ返されます。	false
XForwardedForGaApEnabled	boolean	`GA-AP` ヘッダーを使用して加速リージョンに関する情報を取得するかどうかを示します。有効値： true false 説明このパラメーターは、HTTP および HTTPS リスナーに対してのみ返されます。	false
XForwardedForProtoEnabled	boolean	`GA-X-Forward-Proto` ヘッダーを使用して GA インスタンスのリスナープロトコルを取得するかどうかを示します。有効値： true false 説明このパラメーターは、HTTP および HTTPS リスナーに対してのみ返されます。	false
XForwardedForPortEnabled	boolean	`GA-X-Forward-Port` ヘッダーを使用して GA インスタンスのリスナーポートを取得するかどうかを示します。有効値： true false 説明このパラメーターは、HTTP および HTTPS リスナーに対してのみ返されます。	false
XRealIpEnabled	boolean	`X-Real-IP` ヘッダーを使用してクライアントの IP アドレスを取得するかどうかを示します。有効値： true false 説明このパラメーターは、HTTP および HTTPS リスナーに対してのみ返されます。	false
SecurityPolicyId	string	セキュリティポリシーの ID。 tls_cipher_policy_1_0 サポートされている Transport Layer Security (TLS) バージョン：TLS 1.0、TLS 1.1、および TLS 1.2。サポートされている暗号スイート：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA、および DES-CBC3-SHA。 tls_cipher_policy_1_1 サポートされている TLS バージョン：TLS 1.1 および TLS 1.2。サポートされている暗号スイート：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA、および DES-CBC3-SHA。 tls_cipher_policy_1_2 サポートされている TLS バージョン：TLS 1.2。サポートされている暗号スイート：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA、および DES-CBC3-SHA。 tls_cipher_policy_1_2_strict サポートされている TLS バージョン：TLS 1.2。サポートされている暗号スイート：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、ECDHE-RSA-AES128-SHA、および ECDHE-RSA-AES256-SHA。 tls_cipher_policy_1_2_strict_with_1_3 サポートされている TLS バージョン：TLS 1.2 および TLS 1.3。サポートされている暗号スイート：TLS_AES_128_GCM_SHA256、TLS_AES_256_GCM_SHA384、TLS_CHACHA20_POLY1305_SHA256、TLS_AES_128_CCM_SHA256、TLS_AES_128_CCM_8_SHA256、ECDHE-ECDSA-AES128-GCM-SHA256、ECDHE-ECDSA-AES256-GCM-SHA384、ECDHE-ECDSA-AES128-SHA256、ECDHE-ECDSA-AES256-SHA384、ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、ECDHE-ECDSA-AES128-SHA、ECDHE-ECDSA-AES256-SHA、ECDHE-RSA-AES128-SHA、および ECDHE-RSA-AES256-SHA。説明このパラメーターは、HTTPS リスナーに対してのみ返されます。	tls_cipher_policy_1_0
Type	string	リスナーのルーティングタイプ。有効値： Standard：インテリジェントルーティング。 CustomRouting：カスタムルーティング。	Standard
ServiceId	string	インスタンスを管理するサービスの ID。説明このパラメーターは、ServiceManaged の値が true の場合にのみ返されます。	ALB
ServiceManaged	boolean	インスタンスが管理されているかどうかを示します。有効値： true false	true
ServiceManagedInfos	array<object>	ユーザーがマネージドインスタンスで実行できる操作。説明このパラメーターは、ServiceManaged の値が true の場合にのみ返されます。ユーザーは、マネージドインスタンスで特定の操作のみを実行できます。
	object	ユーザーがこのマネージドインスタンスで実行できるアクションポリシーのリスト。
Action	string	マネージドインスタンスに対する操作の名前。有効値： Create Update Delete Associate UserUnmanaged CreateChild	Update
ChildType	string	子リソースのタイプ。有効値： Listener：リスナー。 IpSet：加速リージョン。 EndpointGroup：エンドポイントグループ。 ForwardingRule：転送ルール。 Endpoint：エンドポイント。 EndpointGroupDestination：カスタムルーティングリスナーに関連付けられたエンドポイントグループのプロトコルマッピング。 EndpointPolicy：カスタムルーティングリスナーに関連付けられたエンドポイントのトラフィックポリシー。説明このパラメーターは、Action の値が CreateChild の場合にのみ返されます。	Listener
IsManaged	boolean	指定された操作が管理されているかどうかを示します。 true：指定された操作は管理されており、ユーザーはマネージドインスタンスで指定された操作を実行できません。 false：指定された操作は管理されておらず、ユーザーはマネージドインスタンスで指定された操作を実行できます。	false
IdleTimeout	integer	アイドル接続のタイムアウト期間。単位：秒。	900
RequestTimeout	integer	HTTP または HTTPS リクエストのタイムアウト期間。単位：秒。説明このパラメーターは、HTTP および HTTPS リスナーに対してのみ返されます。指定されたタイムアウト期間内にバックエンドサーバーから応答がない場合、GA はクライアントに HTTP 504 エラーコードを返します。	60
HttpVersion	string	HTTP プロトコルの最大バージョン。有効値： http3 http2 http1.1 説明このパラメーターは、HTTPS リスナーに対してのみ返されます。	http2

例

成功レスポンス

JSONJSON

{
  "Description": "Listener",
  "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8\t",
  "State": "active",
  "CreateTime": "1577786252000",
  "PortRanges": [
    {
      "FromPort": 20,
      "ToPort": 20
    }
  ],
  "BackendPorts": [
    {
      "FromPort": "80",
      "ToPort": "80"
    }
  ],
  "Certificates": [
    {
      "Type": "Server",
      "Id": "449****-cn-hangzhou"
    }
  ],
  "Protocol": "tcp",
  "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
  "ClientAffinity": "SOURCE_IP",
  "Name": "Listener",
  "RelatedAcls": [
    {
      "AclId": "123",
      "Status": "off"
    }
  ],
  "AclType": "white",
  "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
  "ProxyProtocol": false,
  "XForwardedForConfig": {
    "XForwardedForGaIdEnabled": false,
    "XForwardedForGaApEnabled": false,
    "XForwardedForProtoEnabled": false,
    "XForwardedForPortEnabled": false,
    "XRealIpEnabled": false
  },
  "SecurityPolicyId": "tls_cipher_policy_1_0",
  "Type": "Standard",
  "ServiceId": "ALB",
  "ServiceManaged": true,
  "ServiceManagedInfos": [
    {
      "Action": "Update",
      "ChildType": "Listener",
      "IsManaged": false
    }
  ],
  "IdleTimeout": 900,
  "RequestTimeout": 60,
  "HttpVersion": "http2"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	NotExist.Listener	listener %s is not exist
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.

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

変更履歴

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