この API を呼び出して、リスナーを作成できます。

デバッグ

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

リクエストパラメーター

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

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

AcceleratorId String 必須 ga-bp1odcab8tmno0hdq****

リスナーを追加する Global Accelerator インスタンスの ID を設定します。

説明 String 必須 リスナー

リスナーの説明です。

Name String 必須 Listener

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

名前は長さが 2 文字から 128 文字で、英数字、アンダースコア (_)、ハイフン (-) が使用できます。 先頭は文字または漢字とする必要があります。

PortRanges.N.FromPort Integer 必須 20

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

PortRanges.N.ToPort Integer 必須 20

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

RegionId String 必須 cn-hangzhou

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

ClientToken String 任意 123e4567-e89b-12d3-a456-426655440000

リクエストのべき等性を保証するために使用されるクライアントトークンを設定します。 クライアントを使用して値を生成できますが、他のリクエストと重複しないことを確認する必要があります。 トークンには ASCII 文字のみ使用でき、長さは最大 64 文字です。

ClientAffinity String 任意 SOURCE_IP

リスナーのクライアントアフィニティを有効にするかどうかを指定します。

  • このパラメーターにデフォルト値を指定しない場合、クライアントアフィニティは無効です。 クライアントアフィニティが無効な場合、特定の送信元 (クライアント) IP アドレスからの接続が常に同じエンドポイントにルーティングされるとは限りません。
  • 値を SOURCE_IP に設定すると、クライアントアフィニティが有効になります。 クライアントアフィニティを有効にすると、特定の送信元 (クライアント) IP アドレスからの接続は常に同じエンドポイントにルーティングされます。
Protocol String 任意 tcp

リスナーのネットワーク伝送プロトコルを設定します。 設定可能な値は以下のとおりです。

  • tcp:TCP プロトコル
  • udp:UDP プロトコル

レスポンスパラメーター

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

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

ListenerId String lsr-bp1bpn0kn908w4nbw****

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

コーディング例

リクエストの例

http(s)://[Endpoint]/? Action=CreateListener
&AcceleratorId=ga-bp1odcab8tmno0hdq****
&Description=Listener
&Name=Listener
&PortRanges.1.FromPort=20
&PortRanges.1.ToPort=20
&RegionId=cn-hangzhou
&<Common request parameters>

通常のレスポンス例

XML 形式

<CreateListenerResponse>
      <ListenerId>lsr-bp1bpn0kn908w4nbw****</ListenerId>
      <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
</CreateListenerResponse>

JSON 形式

{
   "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
   "RequestId":"04F0F334-1335-436C-A1D7-6C044FE73368"
}

エラーコード

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