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

説明 

この操作は、各リスナーの状態、各リスナーがいつ作成されたかを示すタイムスタンプ、リスナーポートなど、GAインスタンスのリスナーに関する情報を照会するために使用されます。

デバッグ

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

リクエストパラメーター

項目 データ型 必須/任意 例: 説明 
操作 String 必須 ListListeners

実行する操作です。 値をリスナーに設定します。

RegionId String 必須 cn-hangzhou

GAインスタンスがデプロイされているリージョンのID。 値をcn-hangzhouに設定します。

PageNumber Integer いいえ 1

返されるページ数。 既定値:1

PageSize Integer いいえ 10

各ページで返されるエントリ数。 最大値:50 既定値:1

AcceleratorId String 必須 ga-bp1odcab8tmno0hdq****

GA インスタンスの ID です。

レスポンスパラメーター

項目 データ型 例: 説明 
TotalCount Integer 1

返されたエントリの総数。

リスナー リスナーの配列

リスナーに関する情報。

証明書 証明書の配列

SSL証明書の詳細。

種類 String サーバー

証明書のタイプ。

Serverのみを返すことができます。これは、サーバー証明書を示します。

Id String 44983xxxx-cn-hangzhou

SSL証明書のID。

BackendPorts BackendPortの配列

バックエンドサーバーで使用できるポートの詳細。

FromPort String 80

バックエンドサーバーが使用するポートの範囲内の開始ポート。

ToPort String 80

バックエンドサーバーが使用するポートの範囲内の終了ポート。

ListenerId String lsr-bp1bpn0kn908w4nbw****

リスナーの ID を示します。

説明  String Listener

リスナーの説明です。

State String active

リスナーの状態。 有効な値:

  • active: The listener is normal.
  • init: リスナーは初期化中です。
  • updating: The listener is being configured.
  • deleting: リスナーは削除中です。
ClientAffinity String SOURCE_IP

リスナーに対してクライアントアフィニティが有効であることを示します。

  • NONEが返された場合、クライアントアフィニティは無効になります。 この場合、同じクライアントからの要求は、異なるエンドポイントに転送され得る。
  • SOURCE_IPが返された場合、クライアントアフィニティは有効になります。 この場合、クライアントがステートフルアプリケーションにアクセスすると、同じクライアントからの要求は、送信元ポートまたはプロトコルに関係なく、常に同じエンドポイントに転送されます。
プロトコル String tcp

リスナーが使用するネットワーク伝送プロトコル。 有効な値:

  • tcp: TCP
  • udp: UDP
  • http: HTTP
  • https: HTTPS
CreateTime Long 1577786252000

リスナーが作成されたことを示すタイムスタンプ。 単位:ミリ秒。

PortRanges ポート範囲の配列

リスナーポートの詳細。

FromPort Integer 20

リクエストを受信してエンドポイントに転送するために使用されるリスナーポートの範囲内の開始ポート。

ToPort Integer 20

リクエストを受信してエンドポイントに転送するために使用されるリスナーポートの範囲内の開始ポート。

名前 String リスナー

リスナーの名前を示します。

ProxyProtocol ブール 真実

クライアントIPアドレス保存機能が有効かどうかを示します。 有効な値:

  • true: クライアントのIPアドレス保存機能が有効になっています。 クライアントIPアドレスが予約された後、バックエンドサービスを介してクライアントのソースIPアドレスを表示できます。
  • false: クライアントのIPアドレス保存機能は無効です。
AcceleratorId String ga-bp1odcab8tmno0hdq****

GA インスタンスの ID です。

XForwardedForConfig オブジェクト

XForwardヘッダーの設定。

XForwardedForGaIdEnabled ブール

GA-IDヘッダーを使用してGAインスタンスのIDを取得するかどうかを示します。 有効な値:

  • true: はい
  • false: いいえ
説明 このパラメーターは、HTTPおよびHTTPSリスナーに対してのみ返されます。
XRealIpEnabled ブール

X-Real-IPヘッダーを使用してクライアントIPアドレスを取得するかどうかを示します。 有効な値:

  • 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リスナーに対してのみ返されます。
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: カスタムルーティング
PageSize Integer 10

1 ページあたりで返されるエントリ数。

RequestId String 6FEA0CF3-D3B9-43E5-A304-D217037876A8

リクエストの ID です。

PageNumber Integer 1

返されたページ数。

リクエストの例

http(s)://[Endpoint]/?Action=Listeners
&RegionId=cn-hangzhou
&PageNumber=1
&PageSize=10
&AcceleratorId=ga-bp1odcab8tmno0hdq ****
&<共通リクエストパラメーター>

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

XML 形式

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

<ListListenersResponse>
    <TotalCount> 1 </ TotalCount>
    <Listeners>
        <証明書>
            <タイプ> サーバー </タイプ>
            <Id>44983xxxx-cn-hangzhou</Id>
        </証明書>
        <BackendPorts>
            <FromPort>80</FromPort>
            <ToPort>80</ToPort>
        </BackendPorts>
        <ListenerId>lsr-bp1bpn0kn908w4nbw****</ListenerId>
        <Description> リスナー </Description>
        <State>active</State>
        <ClientAffinity>SOURCE_IP</ClientAffinity>
        <Protocol>TCP</Protocol>
        <CreateTime>1577786252000</CreateTime>
        <PortRanges>
            <FromPort>20</FromPort>
            <ToPort>20</ToPort>
        </PortRanges>
        <名前> リスナー </名前>
        <ProxyProtocol>true</ProxyProtocol>
        <AcceleratorId>ga-bp1odcab8tmno0hdq ****</AcceleratorId>
        <XForwardedForConfig>
            <XForwardedForGaIdEnabled>false</XForwardedForGaIdEnabled>
            <XRealIpEnabled>false</XRealIpEnabled>
            <XForwardedForGaApEnabled>false</XForwardedForGaApEnabled>
            <XForwardedForProtoEnabled>false</XForwardedForProtoEnabled>
            <XForwardedForPortEnabled>false</XForwardedForPortEnabled>
        </XForwardedForConfig>
        <SecurityPolicyId>tls_cipher_policy_1_0</SecurityPolicyId>
    </Listeners>
    <のPageSize> 10 </がPageSize>
    <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8</RequestId>
    <PageNumber>1</PageNumber>
</ListListenersResponse>

JSON 形式

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

{
  "TotalCount" : 1、
  "Listeners" : [ {
    "Certificates" : [ {
      "タイプ" : "サーバー" 、
      "Id" : "44983xxxx-cn-hangzhou"
    } ],
    "BackendPorts" : [ {
      "FromPort" : "80" 、
      "ToPort" : "80"
    } ],
    "ListenerId" : "lsr-bp1bpn0kn908w4nbw ****" 、
    "Description" : "Listener" 、
    "状態" : "アクティブ" 、
    "ClientAffinity" : "SOURCE_IP" 、
    "プロトコル" : "TCP" 、
    "CreateTime" : 1577786252000、
    "PortRanges" : [ {
      "FromPort" : 20、
      "ToPort" : 20
    } ],
    "名前" : "リスナー" 、
    "ProxyProtocol" : true、
    "AcceleratorId" : "ga-bp1odcab8tmno0hdq ****" 、
    "XForwardedForConfig" : {
      "XForwardedForGaIdEnabled" : false、
      "XRealIpEnabled" : false、
      "XForwardedForGaApEnabled" : false、
      "XForwardedForProtoEnabled" : false、
      "XForwardedForPortEnabled" : false
    },
    "SecurityPolicyId" : "tls_cipher_policy_1_0"
  } ],
  "PageSize" : 10,
  "RequestId" : "6FEA0CF3-D3B9-43E5-A304-D217037876A8" 、
  "PageNumber" : 1
}

エラーコード

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