この API を呼び出して、Global Accelerator インスタンス用に設定されたリスナーを照会できます。

デバッグ

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

リクエストパラメーター

パラメーター データ型 必須 / 任意 説明
AcceleratorId String 必須 ga-bp1odcab8tmno0hdq****

照会されるリスナーが属する Global Accelerator インスタンスの ID。

PageNumber Integer 必須 1

返されるページ数です。 ページは 1 ページ目から始まります。 デフォルト値:1

RegionId String 必須 cn-hangzhou

Global Accelerator インスタンスのリージョン ID。 値を cn-hangzhou に設定します。

PageSize Integer 任意 10

返される各ページのエントリ数です。 有効値:1~100 。 デフォルト値:10

レスポンスパラメーター

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

リクエストの ID。

TotalCount Integer 1

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

PageNumber Integer 1

返されたページの数。

PageSize Integer 10

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

Listeners Array

リスナーに関する情報。

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 Long 1577786252000

リスナーが作成された時刻。

PortRanges Array

リスナーポートに関する情報。

FromPort Integer 20

エンドポイントへのリクエストの受信と転送のために指定されたポート範囲の最初のリスニングポート。

ToPort Integer 20

エンドポイントへのリクエストの受信と転送のために指定されたポート範囲の最後のリスニングポート。

コーディング例

リクエストの例

http(s)://[Endpoint]/? Action=ListListeners
&AcceleratorId=ga-bp1odcab8tmno0hdq****
&PageNumber=1
&RegionId=cn-hangzhou
&<Common request parameters>

通常のレスポンス例

XML 形式

<ListListenersResponse>
  <PageNumber>1</PageNumber>
  <TotalCount>1</TotalCount>
  <PageSize>10</PageSize>
  <Listeners>
        <ClientAffinity></ClientAffinity>
        <Name>dede</Name>
        <PortRanges>
              <ToPort>80</ToPort>
              <FromPort>80</FromPort>
        </PortRanges>
        <State>active</State>
        <CreateTime>1581669998000</CreateTime>
        <Protocol>TCP</Protocol>
        <ListenerId>lsr-bp12tl35dpsilnsb1****</ListenerId>
  </Listeners>
  <RequestId>4150E70A-E6FB-4707-BF71-39483DF85C74</RequestId>
</ListListenersResponse>

JSON 形式

{
  "PageNumber": 1,
  "TotalCount": 1,
  "PageSize": 10,
  "Listeners": [
    {
      "ClientAffinity": "",
      "Name": "dede",
      "PortRanges": [
        {
          "ToPort": 80,
          "FromPort": 80
        }
      ],
      "State": "active",
      "CreateTime": 1581669998000,
      "Protocol": "TCP",
      "ListenerId": "lsr-bp12tl35dpsilnsb1****"
    }
  ],
  "RequestId": "4150E70A-E6FB-4707-BF71-39483DF85C74"
}

エラーコード

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