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

説明　

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

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター


項目	データ型	必須／任意	例:	説明
操作	String	必須	DescribeListener	実行する操作です。値をDescribeListenerに設定します。
RegionId	String	必須	cn-hangzhou	GAインスタンスがデプロイされているリージョンのID。値をcn-hangzhouに設定します。
ListenerId	String	必須	lsr-bp1bpn0kn908w4nbw****	照会するリスナーのID。

レスポンスパラメーター


項目	データ型	例:	説明
説明	String	Listener	リスナーの説明です。
RequestId	String	6FEA0CF3-D3B9-43E5-A304-D217037876A8	リクエストの ID です。
State	String	active	リスナーの状態。有効な値： configuring: リスナーは設定中です。 init: リスナーは初期化中です。 updating: リスナーは更新中です。 deleting: リスナーは削除中です。
CreateTime	String	1577786252000	リスナーが作成されたときのタイムスタンプ。単位：ミリ秒。
PortRanges	ポート範囲の配列		リスナーポートの詳細。
FromPort	Integer	20	リクエストを受信してエンドポイントに転送するために使用されるリスニングポートの範囲内の開始ポート。
ToPort	Integer	20	リクエストを受信してエンドポイントに転送するために使用されるリスニングポートの範囲内のエンドポート。
BackendPorts	BackendPortの配列		バックエンドポートの詳細。
FromPort	String	80	バックエンドサーバーがリクエストを受信するために使用するポートの範囲内の開始ポート。このパラメーターは、HTTPSリスナーを設定し、リスニングポートがバックエンドサーバーがサービスを提供するために使用するポートと同じである場合にのみ返されます。
ToPort	String	80	バックエンドサーバーがリクエストを受信するために使用するポートの範囲内の終了ポート。
証明書	証明書の配列		SSL証明書。
種類	String	サーバー	証明書のタイプ。 Serverのみ返却できます。この値は、サーバー証明書を示します。
Id	String	449 ****-cn-hangzhou	SSL証明書のID。
プロトコル	String	tcp	リスナーが使用するネットワーク伝送プロトコル。有効な値： tcp: TCP udp: UDP http: HTTP https: HTTPS
ListenerId	String	lsr-bp1bpn0kn908w4nbw****	リスナーの ID を示します。
ClientAffinity	String	SOURCE_IP	リスナーに対してクライアントアフィニティが有効であることを示します。 NONEが返された場合、クライアントアフィニティは無効になります。この場合、同じクライアントからの要求は、異なるエンドポイントに転送され得る。 SOURCE_IPが返された場合、クライアントアフィニティは有効になります。この場合、クライアントがステートフルアプリケーションにアクセスすると、同じクライアントからの要求は、送信元ポートまたはプロトコルに関係なく、常に同じエンドポイントに転送されます。
名前	String	リスナー	リスナーの名前を示します。
RelatedAcls	relatedAclsの配列		リスナーに関連付けられているアクセス制御リスト (ACL) に関する情報。
AclId	String	123	リスナーに関連付けられているACLのID。
Status	String	off	アクセス制御機能が有効かどうかを示します。有効な値： on: enabled off: 無効
AclType	String	white	ACL のタイプを設定します。有効な値： white: ホワイトリスト。 ACLのIPアドレスまたはCIDRブロックからのリクエストのみが転送されます。ホワイトリストは、指定したIPアドレスのみにアプリケーションへのアクセスを許可するシナリオに適用されます。ホワイトリストが適切に構成されていないと、サービスに悪影響を及ぼす可能性があります。リスナーにホワイトリストを設定すると、ホワイトリストに追加されたIPアドレスからのリクエストのみがリスナーによって転送されます。ホワイトリストが有効になっているが、ACLにIPアドレスが追加されていない場合、リスナーはリクエストを転送しません。 black: ブラックリスト。 ACLのIPアドレスまたはCIDRブロックからのすべてのリクエストがブロックされます。ブラックリストは、特定のIPアドレスからアプリケーションへのアクセスを拒否するシナリオに適用されます。ブラックリストが有効になっているが、ACLにIPアドレスが追加されていない場合、リスナーはすべてのリクエストを転送します。 Statusの値がonの場合、このパラメーターが返されます。
AcceleratorId	String	ga-bp1odcab8tmno0hdq****	GA インスタンスの ID です。
ProxyProtocol	ブール	偽	クライアントIPアドレス保存機能が有効かどうかを示します。有効な値： true: クライアントのIPアドレス保存機能が有効になっています。クライアントIPアドレスが予約された後、バックエンドサービスを介してクライアントのソースIPアドレスを表示できます。 false: クライアントのIPアドレス保存機能は無効です。
XForwardedForConfig	オブジェクト		`XForward`ヘッダーの設定。
XForwardedForGaIdEnabled	ブール	偽	`GA-ID`ヘッダーを使用してGAインスタンスのIDを取得するかどうかを示します。有効な値： true: はい false: いいえ説明このパラメーターは、HTTPおよびHTTPSリスナーに対してのみ返されます。
XForwardedForGaApEnabled	ブール	偽	`GA-AP`ヘッダーを使用してアクセラレーションリージョンに関する情報を取得するかどうかを示します。有効な値： true: はい false: いいえ説明このパラメーターは、HTTPおよびHTTPSリスナーに対してのみ返されます。
XForwardedForProtoEnabled	ブール	偽	`GA-X-Forward-Proto`ヘッダーを使用してGAインスタンスのリスナープロトコルを取得するかどうかを示します。有効な値： true: はい false: いいえ説明このパラメーターは、HTTPおよびHTTPSリスナーに対してのみ返されます。
XForwardedForPortEnabled	ブール	偽	`GA-X-Forward-Port`ヘッダーを使用してGAインスタンスのリスナーポートを取得するかどうかを示します。有効な値： true: はい false: いいえ説明このパラメーターは、HTTPおよびHTTPSリスナーに対してのみ返されます。
XRealIpEnabled	ブール	偽	`X-Real-IP`ヘッダーを使用してクライアントIPアドレスを取得するかどうかを示します。有効な値： true false 説明このパラメーターは、HTTPおよびHTTPSリスナーに対してのみ返されます。
SecurityPolicyId	String	tls_cipher_policy_1_0	セキュリティポリシーの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 Supported暗号スイート: 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リスナーに対してのみ返されます。
種類	String	スタンダード	リスナーのルーティングタイプ。有効な値：標準: インテリジェントルーティング CustomRouting: カスタムルーティング

例

リクエストの例

http(s)://[Endpoint]/?Action=DescribeListener
&RegionId=cn-hangzhou
&ListenerId=lsr-bp1bpn0kn908w4nbw ****
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeListenerResponse>
    <Description> リスナー </Description>
    <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8 </RequestId>
    <State>active</State>
    <CreateTime>1577786252000</CreateTime>
    <PortRanges>
        <FromPort>20</FromPort>
        <ToPort>20</ToPort>
    </PortRanges>
    <BackendPorts>
        <FromPort>80</FromPort>
        <ToPort>80</ToPort>
    </BackendPorts>
    <証明書>
        <タイプ> サーバー </タイプ>
        <Id>449 ****-cn-hangzhou</Id>
    </証明書>
    <Protocol>TCP</Protocol>
    <ListenerId>lsr-bp1bpn0kn908w4nbw****</ListenerId>
    <ClientAffinity>SOURCE_IP</ClientAffinity>
    <名前> リスナー </名前>
    <RelatedAcls>
        <AclId>123</AclId>
        <ステータス> オフ </ステータス>
    </RelatedAcls>
    <AclType>white</AclType>
    <AcceleratorId>ga-bp1odcab8tmno0hdq ****</AcceleratorId>
    <ProxyProtocol>false</ProxyProtocol>
    <XForwardedForConfig>
        <XForwardedForGaIdEnabled>false</XForwardedForGaIdEnabled>
        <XForwardedForGaApEnabled>false</XForwardedForGaApEnabled>
        <XForwardedForProtoEnabled>false</XForwardedForProtoEnabled>
        <XForwardedForPortEnabled>false</XForwardedForPortEnabled>
        <XRealIpEnabled>false</XRealIpEnabled>
    </XForwardedForConfig>
    <SecurityPolicyId>tls_cipher_policy_1_0</SecurityPolicyId>
    <タイプ> 標準 </タイプ>
</DescribeListenerResponse>

JSON 形式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Description" : "Listener" 、
  "RequestId" : "6FEA0CF3-D3B9-43E5-A304-D217037876A8\t" 、
  "状態" : "アクティブ" 、
  "CreateTime" : "1577786252000",
  "PortRanges" : [ {
    "FromPort" : 20、
    "ToPort" : 20
  } ],
  "BackendPorts" : [ {
    "FromPort" : "80" 、
    "ToPort" : "80"
  } ],
  "Certificates" : [ {
    "タイプ" : "サーバー" 、
    "Id" : "449 ****-cn-hangzhou"
  } ],
  "プロトコル" : "TCP" 、
  "ListenerId" : "lsr-bp1bpn0kn908w4nbw ****" 、
  "ClientAffinity" : "SOURCE_IP" 、
  "名前" : "リスナー" 、
  "RelatedAcls" : [ {
    "AclId" : "123" 、
    "ステータス" : "オフ"
  } ],
  "AclType" : "ホワイト" 、
  "AcceleratorId" : "ga-bp1odcab8tmno0hdq ****" 、
  "ProxyProtocol" : false、
  "XForwardedForConfig" : {
    "XForwardedForGaIdEnabled" : false、
    "XForwardedForGaApEnabled" : false、
    "XForwardedForProtoEnabled" : false、
    "XForwardedForPortEnabled" : false、
    "XRealIpEnabled" : false
  },
  "SecurityPolicyId" : "tls_cipher_policy_1_0" 、
  "タイプ" : "標準"
}

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。