この API を呼び出して、リスナーの情報を照会します。

デバッグ

OpenAPI Explorer はシグネチャの値を自動的に計算します。 この API は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer を使用すると、さまざまな SDK 向けにサンプルコードを動的に生成することができます。

リクエストパラメーター

パラメーター データ型 必須 / 任意 説明
Action String 必須 DescribeListener

実行する API (DescribeDBInstances ) を設定します。

ListenerId String 必須 lsr-bp1bpn0kn908w4nbw****

照会するインスタンスの ID を設定します。

RegionId String 必須 cn-hangzhou

指定されたリスナーが属する Global Accelerator インスタンスのリージョン ID を設定します。 値を cn-hangzhou に設定します。

レスポンスパラメーター

Parameter データ型 説明
RequestId String 6FEA0CF3-D3B9-43E5-A304-D217037876A8

リクエストの ID を示します。

ListenerId String lsr-bp1bpn0kn908w4nbw****

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

Name String Listener

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

説明 String Listener

リスナーの説明です。

Protocol String TCP

リスナーのネットワーク伝送プロトコルを示します。

  • TCP :TCPプロトコル
  • UDP :UDPプロトコル
ClientAffinity String SOURCE_IP

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

  • null 値が返された場合、クライアントアフィニティは無効です。 クライアントアフィニティが無効な場合、特定の送信元 (クライアント) IP アドレスからの接続が常に同じエンドポイントにルーティングされるとは限りません。
  • SOURCE_IP が返され他場合、クライアントアフィニティは有効です。 クライアントアフィニティが有効な場合、特定の送信元 (クライアント) IP アドレスからの接続は常に同じエンドポイントにルーティングされます。
State String active

リスナーのステータスを示します。

  • active : 正常
  • creating :作成中
  • configuring:設定中
CreateTime String 1577786252000

インスタンスが作成された時刻を示します。

PortRanges Array

リスナーポートに関する情報を示します。

FromPort Integer 20

エンドポイントへのリクエストを受信して転送するために指定されたポート範囲の最初のリスニングポートを示します。

ToPort Integer 20

エンドポイントへのリクエストを受信して転送するために指定されたポート範囲の最後のリスニングポートを示します。

コーディング例

リクエストの例

http(s)://[Endpoint]/? Action=DescribeListener
&ListenerId=lsr-bp1bpn0kn908w4nbw****
&RegionId=cn-hangzhou
&<Common request parameters>

通常のレスポンス例

XML 形式

<DescribeListenerResponse>    
      <Name>dede</Name>
      <PortRanges>
            <ToPort>80</ToPort>
            <FromPort>80</FromPort>
      </PortRanges>
      <State>active</State>
      <RequestId>50B8F1A7-D58B-4286-9938-26686AC93863</RequestId>
      <CreateTime>1581669998000</CreateTime>
      <Protocol>TCP</Protocol>
      <ListenerId>lsr-bp12tl35dpsilnsb1****</ListenerId>
</DescribeListenerResponse>

JSON 形式

{
  "Name": "dede",
  "PortRanges": [
    {
      "ToPort": 80,
      "FromPort": 80
    }
  ],
  "State": "active",
  "RequestId": "50B8F1A7-D58B-4286-9938-26686AC93863",
  "CreateTime": 1581669998000,
  "Protocol": "TCP",
  "ListenerId": "lsr-bp12tl35dpsilnsb1****"
}

エラーコード

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