DescribeListener API による 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	必須	Alibaba Cloud Global Accelerator (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	リスナーが作成された日時を示すタイムスタンプ。単位：ミリ秒。	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	証明書のタイプ。サーバー証明書を示す 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>	リスナーに関連付けられているアクセス制御ポリシグループ。
	object	リスナーに関連付けられているアクセス制御ポリシグループ。
AclId	string	リスナーに関連付けられているアクセス制御リスト (ACL) の ID。	123
Status	string	アクセス制御機能が有効になっているかどうかを示します。 Associated：アクセス制御機能が有効になっています。	Associated
AclType	string	ACL のタイプ。 white：ホワイトリスト。ACL 内の IP アドレスまたは CIDR ブロックからのリクエストのみが転送されます。ホワイトリストは、特定の IP アドレスからのアクセスのみを許可するアプリケーションに適しています。ホワイトリストを有効にしても ACL に IP アドレスを追加しない場合、GA リスナーはリクエストを転送しません。 black：ブラックリスト。ACL 内の IP アドレスまたは CIDR ブロックからのすべてのリクエストが拒否されます。ブラックリストは、特定の IP アドレスからのアクセスを拒否するアプリケーションに適しています。ブラックリストを有効にしても ACL に IP アドレスを追加しない場合、GA リスナーはすべてのリクエストを転送します。このパラメーターは、ACL がリスナーに関連付けられている場合に返されます。	white
AcceleratorId	string	GA インスタンスの ID。	ga-bp1odcab8tmno0hdq****
ProxyProtocol `deprecated`	boolean	プロキシプロトコルを使用してクライアント IP アドレスを保持するかどうかを示します。 true：プロキシプロトコルを使用してクライアント IP アドレスを保持します。この機能を有効にすると、バックエンドサービスでクライアントの元の IP アドレスを表示できます。 false：プロキシプロトコルを使用してクライアント IP アドレスを保持しません。	false
XForwardedForConfig	object	`X-Forwarded-For` ヘッダーの設定。
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 サポートされる 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：HTTP/3。 http2：HTTP/2。 http1.1：HTTP/1.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": "Associated"
    }
  ],
  "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.

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

変更履歴

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