CreateListener API を使用してリスナーを作成 - GA - Alibaba Cloud - Global Accelerator

Global Accelerator インスタンスにリスナーを作成します。

操作説明

この操作を呼び出す際は、以下の点にご注意ください。

CreateListener は非同期操作です。リクエストを送信すると、システムからリスナー ID が返されますが、リスナーの作成はバックグラウンドで継続されます。リスナーのステータスを確認するには、DescribeListener を呼び出してください。
- init ステータスは、リスナーが作成中であることを示します。この状態では、クエリ操作のみ実行可能です。
- active ステータスは、リスナーが準備完了であることを示します。
同一の Global Accelerator インスタンスに対して、CreateListener 操作を同時に複数回実行して複数のリスナーを作成することはできません。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ga:CreateListener

create

*Listener

acs:ga:{#regionId}:{#accountId}:listener/*

*Accelerator

acs:ga:{#regionId}:{#accountId}:ga/{#acceleratorId}

ga:TLSVersion

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	Global Accelerator インスタンスのリージョン ID。値は cn-hangzhou に設定します。	cn-hangzhou
ClientToken	string	任意	リクエストのべき等性を保証するクライアントトークン。各リクエストに対してクライアント側で一意のトークンを生成します。トークンには ASCII 文字のみを使用できます。説明このパラメーターを省略した場合、システムはリクエストの RequestId を ClientToken として使用します。	123e4567-e89b-12d3-a456-426655440000
AcceleratorId	string	必須	Global Accelerator インスタンスの ID。	ga-bp1odcab8tmno0hdq****
Name	string	任意	リスナーの名前。名前の長さは 1～128 文字で、英字または漢字で始まり、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を含めることができます。	Listener
Description	string	任意	リスナーの説明。説明の長さは最大 200 文字で、`http://` または `https://` で始まらないようにしてください。	Listener
ClientAffinity	string	任意	リスナーのクライアントアフィニティ。デフォルトではクライアントアフィニティは無効化されており、同一クライアントからのリクエストは異なるエンドポイントにルーティングされる可能性があります。 SOURCE_IP を指定するとクライアントアフィニティが有効化されます。この設定により、送信元ポートやプロトコルに関係なく、同一クライアントからのすべてのリクエストが同一エンドポイントにルーティングされます。	SOURCE_IP
Protocol	string	任意	リスナーのネットワークプロトコル。有効な値： tcp：TCP udp：UDP http：HTTP https：HTTPS	tcp
PortRanges	array<object>	必須	リスナーのポート範囲。ポート番号は 1～65499 の範囲内である必要があります。許可されるポート数の上限は、リスナーのルーティングタイプおよびプロトコルによって異なります。詳細については、「リスナーポート」をご参照ください。
	object	任意	リスナーのポート範囲。ポート番号は 1～65499 の範囲内である必要があります。許可されるポート数の上限は、リスナーのルーティングタイプおよびプロトコルによって異なります。詳細については、「リスナーポート」をご参照ください。
FromPort	integer	必須	リスナー範囲の最初のポート。リクエストの受信およびエンドポイントへの転送に使用されます。ポート番号は 1～65499 の範囲内である必要があり、FromPort の値は ToPort の値以下である必要があります。説明 HTTP または HTTPS リスナーの場合、1 つのリスナーポートのみ指定できます。この場合、FromPort の値は ToPort の値と一致する必要があります。	20
ToPort	integer	必須	リスナー範囲の最後のポート。リクエストの受信およびエンドポイントへの転送に使用されます。ポート番号は 1～65499 の範囲内である必要があり、FromPort の値は ToPort の値以下である必要があります。説明 HTTP または HTTPS リスナーの場合、1 つのリスナーポートのみ指定できます。この場合、FromPort の値は ToPort の値と一致する必要があります。	20
Certificates	array<object>	任意	HTTPS リスナー用の SSL 証明書。
	object	任意	HTTPS リスナー用の SSL 証明書。
Id	string	任意	SSL 証明書の ID。説明このパラメーターは、HTTPS リスナーでのみ必須です。	449****-cn-hangzhou
XForwardedForConfig	object	任意	`X-Forwarded-For` 関連ヘッダーの設定項目。
XForwardedForGaIdEnabled	boolean	任意	Global Accelerator インスタンス ID をバックエンドサーバーに渡すために `GA-ID` ヘッダーを使用するかどうかを指定します。有効な値： true false（デフォルト）説明このパラメーターは、HTTP および HTTPS リスナーでのみ適用されます。	false
XForwardedForGaApEnabled	boolean	任意	アクセラレーションリージョンに関する情報をバックエンドサーバーに渡すために `GA-AP` ヘッダーを使用するかどうかを指定します。有効な値： true false（デフォルト）説明このパラメーターは、HTTP および HTTPS リスナーでのみ適用されます。	false
XForwardedForProtoEnabled	boolean	任意	Global Accelerator インスタンスのリスナープロトコルをバックエンドサーバーに渡すために `GA-X-Forward-Proto` ヘッダーを使用するかどうかを指定します。有効な値： true false（デフォルト）説明このパラメーターは、HTTP および HTTPS リスナーでのみ適用されます。	false
XForwardedForPortEnabled	boolean	任意	Global Accelerator インスタンスのリスナーポートをバックエンドサーバーに渡すために `GA-X-Forward-Port` ヘッダーを使用するかどうかを指定します。有効な値： true false（デフォルト）説明このパラメーターは、HTTP および HTTPS リスナーでのみ適用されます。	false
XRealIpEnabled	boolean	任意	クライアントの実際の IP アドレスをバックエンドサーバーに渡すために `X-Real-IP` ヘッダーを使用するかどうかを指定します。有効な値： true false（デフォルト）説明このパラメーターは、HTTP および HTTPS リスナーでのみ適用されます。	false
SecurityPolicyId	string	任意	セキュリティポリシーの 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 サポートされる暗号スイート：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 リスナーでのみ適用されます。	tls_cipher_policy_1_0
Type	string	任意	リスナーのルーティングタイプ。有効な値： Standard（デフォルト）：標準ルーティング CustomRouting：カスタムルーティング説明カスタムルーティングは招待制プレビュー版です。この機能を利用するには、Alibaba Cloud のアカウントマネージャーにお問い合わせください。標準の Global Accelerator インスタンスでは、すべてのリスナーに対して 1 つのルーティングタイプのみをサポートします。リスナー作成後にルーティングタイプを変更することはできません。詳細については、「リスナーの概要」をご参照ください。	Standard
EndpointGroupConfigurations	array<object>	任意	標準リスナーのエンドポイントグループの構成。最大 10 個のエンドポイントグループを指定できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が Standard の場合にのみ適用されます。
	array<object>	任意	標準リスナーのエンドポイントグループの構成。最大 10 個のエンドポイントグループを指定できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が Standard の場合にのみ適用されます。
EndpointGroupName	string	任意	エンドポイントグループの名前。名前の長さは 1～128 文字で、英字または漢字で始まり、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を含めることができます。最大 10 個のエンドポイントグループ名を入力できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が Standard の場合にのみ適用されます。	test
EndpointGroupDescription	string	任意	エンドポイントグループの説明。説明の長さは最大 200 文字で、`http://` または `https://` を含めることはできません。最大 10 個のエンドポイントグループ説明を入力できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が Standard の場合にのみ適用されます。	test
EndpointGroupRegion	string	任意	エンドポイントグループが作成されるリージョンの ID。最大 10 個のエンドポイントグループリージョン ID を入力できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が Standard の場合にのみ適用されます。	cn-hangzhou
TrafficPercentage	integer	任意	トラフィック配分比率。標準リスナーが複数のエンドポイントグループに関連付けられている場合、このパラメーターは各エンドポイントグループに配分されるトラフィックの割合を指定します。有効な値： 1～100。デフォルト値：100。最大 10 個のエンドポイントグループのトラフィック配分値を入力できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が Standard の場合にのみ適用されます。	100
HealthCheckEnabled	boolean	任意	エンドポイントグループのヘルスチェックを有効化するかどうかを指定します。有効な値： true：ヘルスチェックを有効化します。 false（デフォルト）：ヘルスチェックを無効化します。最大 10 個のエンドポイントグループでヘルスチェックを有効化できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が Standard の場合にのみ適用されます。	false
HealthCheckIntervalSeconds	integer	任意	ヘルスチェックの間隔（秒単位）。最大 10 個のヘルスチェック間隔を入力できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が Standard の場合にのみ適用されます。	3
HealthCheckPath	string	任意	ヘルスチェックリクエストを送信するパス。最大 10 個のヘルスチェックパスを入力できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が Standard の場合にのみ適用されます。	/healthcheck
HealthCheckPort	integer	任意	ヘルスチェックに使用するポート。有効な値：1～65535。ヘルスチェック用のポートは最大 10 個まで入力できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が Standard の場合にのみ適用されます。	20
HealthCheckProtocol	string	任意	ヘルスチェックリクエストを送信するプロトコル。有効な値： tcp または TCP：TCP http または HTTP：HTTP https または HTTPS：HTTPS ヘルスチェックプロトコルは最大 10 個まで入力できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が Standard の場合にのみ適用されます。	tcp
ThresholdCount	integer	任意	エンドポイントを正常と見なすために必要な連続成功ヘルスチェック回数、またはエンドポイントを異常と見なすために必要な連続失敗ヘルスチェック回数。有効な値：2～10。デフォルト値：3。ヘルスステータス変更をトリガーする連続ヘルスチェック回数は、最大 10 個まで入力できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が Standard の場合にのみ適用されます。	3
EndpointConfigurations	array<object>	任意	エンドポイントの構成。
	object	任意	エンドポイントの構成。
Type	string	任意	エンドポイントのタイプ。有効な値： Domain：カスタムドメイン名 Ip：カスタム IP アドレス PublicIp：Alibaba Cloud サービスのパブリック IP アドレス ECS：Elastic Compute Service (ECS) インスタンス SLB：Server Load Balancer (SLB) インスタンス ALB：Application Load Balancer (ALB) インスタンス OSS：Object Storage Service (OSS) バケット ENI：弾性ネットワークインターフェース (ENI) NLB：Network Load Balancer (NLB) インスタンス IpTarget：カスタムプライベート IP アドレスエンドポイントグループには最大 100 個のエンドポイントを指定できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が Standard の場合にのみ適用されます。エンドポイントを追加する際、Global Accelerator はサービスリンクロールを作成してリソースにアクセスすることがあります。作成されるロールはエンドポイントのタイプによって異なります。説明詳細については、「サービスリンクロール」をご参照ください。	Ip
Weight	integer	任意	エンドポイントの重み。有効な値：0～255。インテリジェントルーティングタイプのリスナーのエンドポイントグループでは、最大 100 個のエンドポイントの重みを入力できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が Standard の場合にのみ適用されます。エンドポイントの重みを 0 に設定すると、Global Accelerator はそのエンドポイントへのトラフィック送信を停止します。この設定は慎重に使用してください。	20
Endpoint	string	任意	エンドポイントの IP アドレスまたはドメイン名。インテリジェントルーティングリスナーのエンドポイントグループでは、最大 100 個のエンドポイントの IP アドレスまたはドメイン名を入力できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が Standard の場合にのみ適用されます。	47.0.XX.XX
SubAddress	string	任意	ENI のプライベート IP アドレス。説明エンドポイントタイプが ENI の場合にこのパラメーターを指定できます。指定しない場合は、ENI のプライマリプライベート IP アドレスが使用されます。	172.168.XX.XX
EnableClientIPPreservation	boolean	任意	クライアントの送信元 IP アドレスを保持するかどうかを指定します。有効な値： true：機能を有効化します。 false（デフォルト）：機能を無効化します。説明 TCP または UDP リスナーのエンドポイントグループでは、この機能はデフォルトで無効化されています。必要に応じて有効化できます。 HTTP または HTTPS リスナーのエンドポイントグループでは、この機能はデフォルトで有効化されています。クライアントの送信元 IP アドレスは `X-Forwarded-For` ヘッダーから取得されます。この機能を無効化することはできません。 `EnableClientIPPreservation` と `EnableProxyProtocol` をともに `true` に設定することはできません。詳細については、「クライアントの送信元 IP アドレスの保持」をご参照ください。
EnableProxyProtocol	boolean	任意	プロキシプロトコルを使用してクライアントの送信元 IP アドレスを保持するかどうかを指定します。有効な値： true：機能を有効化します。 false（デフォルト）：機能を無効化します。説明このパラメーターは、TCP リスナーのエンドポイントグループでのみ設定できます。 `EnableClientIPPreservation` と `EnableProxyProtocol` をともに `true` に設定することはできません。詳細については、「クライアントの送信元 IP アドレスの保持」をご参照ください。
VpcId	string	任意	Virtual Private Cloud (VPC) の ID。インテリジェントルーティングリスナーのエンドポイントグループでは、最大 1 個の VPC ID を入力できます。説明このパラメーターは、IpTarget エンドポイントでのみ必須です。	vpc-bp13r1kpr2lel****
VSwitchIds	array	任意	VPC 内の vSwitch のリスト。最大 2 個の vSwitch ID を指定できます。
	string	任意	vSwitch の ID。スマートルーティングタイプのリスナーのエンドポイントグループでは、最大 2 個の vSwitch ID を入力できます。説明このパラメーターは、IpTarget エンドポイントでのみ必須です。 vSwitch は、VpcId パラメーターで指定された VPC に属している必要があります。	vsw-0jlhcznhw5m7pz2fa****
Provider	string	任意		BAILIAN
ApiKeys	array	任意
	string	任意		sk-******
EndpointRequestProtocol	string	任意	バックエンドサービスで使用するプロトコル。有効な値： HTTP（デフォルト） HTTPS バックエンドサービスプロトコルは最大 10 個まで入力できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が Standard の場合にのみ適用されます。このパラメーターは、HTTP または HTTPS リスナーのエンドポイントグループでのみ設定できます。 HTTP リスナーの場合、バックエンドサービスプロトコルは HTTP である必要があります。	HTTP
EndpointProtocolVersion	string	任意	バックエンドサービスのプロトコルバージョン。有効な値： HTTP1.1（デフォルト）：HTTP/1.1 HTTP2：HTTP/2 説明このパラメーターは、EndpointRequestProtocol が HTTPS に設定されている場合にのみ利用可能です。	HTTP1.1
EndpointGroupType	string	任意	エンドポイントグループのタイプ。有効な値： default（デフォルト）：デフォルトエンドポイントグループ virtual：仮想エンドポイントグループエンドポイントグループタイプは最大 10 個まで入力できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が Standard の場合にのみ適用されます。仮想エンドポイントグループは、HTTP または HTTPS リスナーでのみ作成できます。	default
PortOverrides	array<object>	任意	ポートマッピング。最大 5 件のポートマッピングを指定できます。
	object	任意	ポートマッピング。
ListenerPort	integer	任意	ポートマッピングで指定されたリスナーポート。ポートマッピング用のリスナーポートは最大 5 個まで入力できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が Standard の場合にのみ適用されます。 TCP リスナーでは、仮想エンドポイントグループに対してポートマッピングを設定できません。既にリスナーに仮想エンドポイントグループが存在する場合、デフォルトエンドポイントグループに対してポートマッピングを設定できません。デフォルトエンドポイントグループに対してポートマッピングが設定されている場合、リスナーに仮想エンドポイントグループを追加できません。ポートマッピングを設定した後、HTTP と HTTPS の切り替えを除き、リスナープロトコルを変更できません。リスナーポート範囲を変更する際は、新しいポート範囲がポートマッピングで指定されたすべてのリスナーポートを含むようにしてください。たとえば、リスナーポート範囲が 80–82 で、リスナーポートがエンドポイントポート 100–102 にマッピングされている場合、リスナーポート範囲を 80–81 に変更することはできません。	443
EndpointPort	integer	任意	ポートマッピングで指定されたエンドポイントポート。ポートマッピング用のエンドポイントポートは最大 5 個まで入力できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が Standard の場合にのみ適用されます。 TCP リスナーでは、仮想エンドポイントグループに対してポートマッピングを設定できません。既にリスナーに仮想エンドポイントグループが存在する場合、デフォルトエンドポイントグループに対してポートマッピングを設定できません。デフォルトエンドポイントグループに対してポートマッピングが設定されている場合、リスナーに仮想エンドポイントグループを追加できません。ポートマッピングを設定した後、HTTP と HTTPS の切り替えを除き、リスナープロトコルを変更できません。リスナーポート範囲を変更する際は、新しいポート範囲がポートマッピングで指定されたすべてのリスナーポートを含むようにしてください。たとえば、リスナーポート範囲が 80–82 で、リスナーポートがエンドポイントポート 100–102 にマッピングされている場合、リスナーポート範囲を 80–81 に変更することはできません。	80
HealthCheckHost	string	任意	ヘルスチェックに使用するドメイン名。	www.taobao.com
EndpointIpVersion	string	任意	バックエンドサービスで使用する IP バージョン。有効な値： IPv4（デフォルト）：GA はバックエンドサービスとの通信に IPv4 アドレスのみを使用します。 IPv6：GA はバックエンドサービスとの通信に IPv6 アドレスのみを使用します。 ProtocolAffinity：GA はクライアントリクエストと同じ IP バージョンを使用してバックエンドサービスと通信します。	IPv4
CustomRoutingEndpointGroupConfigurations	array<object>	任意	カスタムルーティングリスナーのエンドポイントグループの構成。最大 5 個のエンドポイントグループを指定できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が CustomRouting の場合にのみ適用されます。
	array<object>	任意	カスタムルーティングリスナーのエンドポイントグループの構成。最大 5 個のエンドポイントグループを指定できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が CustomRouting の場合にのみ適用されます。
EndpointGroupRegion	string	任意	エンドポイントグループが作成されるリージョンの ID。最大 5 個のエンドポイントグループリージョン ID を入力できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が CustomRouting の場合にのみ適用されます。	cn-hangzhou
Name	string	任意	エンドポイントグループの名前。名前の長さは 1～128 文字で、英字または漢字で始まり、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を含めることができます。最大 5 個のエンドポイントグループ名を入力できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が CustomRouting の場合にのみ適用されます。	test
Description	string	任意	エンドポイントグループの説明。説明の長さは最大 200 文字で、`http://` または `https://` を含めることはできません。最大 5 個のエンドポイントグループ説明を入力できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が CustomRouting の場合にのみ適用されます。	test
DestinationConfigurations	array<object>	任意	エンドポイントグループのマッピング構成。バックエンドサービスのポート範囲およびプロトコルを指定する必要があります。これらの設定は、関連付けられたリスナーポート範囲にマッピングされます。各エンドポイントグループに対して最大 20 個のマッピング構成を指定できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が CustomRouting の場合にのみ適用されます。
	object	任意	エンドポイントグループのマッピング構成。バックエンドサービスのポート範囲およびプロトコルを指定する必要があります。これらの設定は、関連付けられたリスナーポート範囲にマッピングされます。各エンドポイントグループに対して最大 20 個のマッピング構成を指定できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が CustomRouting の場合にのみ適用されます。
Protocols	array	任意	バックエンドサービスのプロトコル。各マッピング構成に対して最大 4 個のバックエンドサービスプロトコルを指定できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が CustomRouting の場合にのみ適用されます。
	string	任意	バックエンドサービスのプロトコル。有効な値： TCP UDP TCP,UDP カスタムルーティングタイプのリスナーの各エンドポイントグループでは、ポートマッピングおよびプロトコルタイプ設定で最大 4 個のバックエンドサービスプロトコルタイプを指定できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が CustomRouting の場合にのみ適用されます。	TCP
FromPort	integer	任意	バックエンドサービスの最初のポート。有効なポート範囲は 1～65499 です。FromPort の値は ToPort の値以下である必要があります。カスタムルーティングタイプのリスナーの各エンドポイントグループでは、最大 20 個のバックエンドサービスの開始ポートを入力できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が CustomRouting の場合にのみ適用されます。	80
ToPort	integer	任意	バックエンドサービスの最後のポート。有効なポート範囲は 1～65499 です。FromPort の値は ToPort の値以下である必要があります。カスタムルーティングタイプのリスナーの各エンドポイントグループでは、最大 20 個のバックエンドサービスポートを入力できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が CustomRouting の場合にのみ適用されます。	80
EndpointConfigurations	array<object>	任意	エンドポイントの構成。各エンドポイントグループに最大 10 個のエンドポイントを指定できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が CustomRouting の場合にのみ適用されます。
	array<object>	任意	エンドポイントの構成。各エンドポイントグループに最大 10 個のエンドポイントを指定できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が CustomRouting の場合にのみ適用されます。
Type	string	任意	カスタムルーティングリスナーのバックエンドサービスのタイプ。有効な値： PrivateSubNet（デフォルト）：プライベート CIDR ブロック。説明このパラメーターは、リスナーのルーティングタイプ（Type）が CustomRouting の場合にのみ適用されます。	PrivateSubNet
Endpoint	string	任意	カスタムルーティングリスナーの vSwitch。説明このパラメーターは、リスナーのルーティングタイプ（Type）が CustomRouting の場合にのみ適用されます。	vsw-test01
TrafficToEndpointPolicy	string	任意	カスタムルーティングリスナーのバックエンドサービスのトラフィックポリシー。有効な値： DenyAll（デフォルト）：指定されたバックエンドサービスへのすべてのトラフィックを拒否します。 AllowAll：指定されたバックエンドサービスへのすべてのトラフィックを許可します。 AllowCustom：特定の送信先へのトラフィックを許可します。許可する送信先の IP アドレスとポート範囲を指定する必要があります。ポート範囲が指定されていない場合、送信先のすべてのポートが許可されます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が CustomRouting の場合にのみ適用されます。	DenyAll
PolicyConfigurations	array<object>	任意	カスタムルーティングリスナーの送信先構成。各エンドポイントに最大 20 個の送信先を指定できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が CustomRouting の場合にのみ適用されます。
	array<object>	任意	カスタムルーティングリスナーの送信先構成。各エンドポイントに最大 20 個の送信先を指定できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が CustomRouting の場合にのみ適用されます。
Address	string	任意	トラフィックの受信を許可する送信先の IP アドレス。このパラメーターは、TrafficToEndpointPolicy が AllowCustom に設定されている場合にのみ必須です。各エンドポイントに最大 20 個の宛先 IP アドレスを指定できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が CustomRouting の場合にのみ適用されます。	10.0.XX.XX
PortRanges	array<object>	任意	トラフィックの受信を許可する送信先のポート範囲。ポート範囲はバックエンドサービスのポート範囲内である必要があります。このパラメーターを空のままにすると、送信先のすべてのポートが許可されます。このパラメーターは、TrafficToEndpointPolicy が AllowCustom に設定されている場合にのみ必須です。各エンドポイントに最大 20 個のポート範囲、各送信先に最大 5 個のポート範囲を指定できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が CustomRouting の場合にのみ適用されます。
	object	任意	トラフィックの受信を許可する送信先のポート範囲。ポート範囲はバックエンドサービスのポート範囲内である必要があります。このパラメーターを空のままにすると、送信先のすべてのポートが許可されます。このパラメーターは、TrafficToEndpointPolicy が AllowCustom に設定されている場合にのみ必須です。各エンドポイントに最大 20 個のポート範囲、各送信先に最大 5 個のポート範囲を指定できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が CustomRouting の場合にのみ適用されます。
FromPort	integer	任意	トラフィックの受信を許可する送信先の最初のポート。ポートはバックエンドサービスのポート範囲内である必要があります。このパラメーターは、TrafficToEndpointPolicy が AllowCustom に設定されている場合にのみ必須です。各エンドポイントに最大 20 個のポート範囲、各送信先に最大 5 個の最初のポートを指定できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が CustomRouting の場合にのみ適用されます。	80
ToPort	integer	任意	トラフィックの受信を許可する送信先の最後のポート。ポートはバックエンドサービスのポート範囲内である必要があります。このパラメーターは、TrafficToEndpointPolicy が AllowCustom に設定されている場合にのみ必須です。各エンドポイントに最大 20 個のポート範囲、各送信先に最大 5 個の最後のポートを指定できます。説明このパラメーターは、リスナーのルーティングタイプ（Type）が CustomRouting の場合にのみ適用されます。	80
IdleTimeout	integer	任意	接続アイドルタイムアウト（秒単位）。 TCP：10～900 秒。デフォルト：900 秒。 UDP：10～20 秒。デフォルト：20 秒。 HTTP/HTTPS：1～60 秒。デフォルト：15 秒。	900
RequestTimeout	integer	任意	HTTP/HTTPS 接続のリクエストタイムアウト（秒単位）。有効な値：1～180 秒。デフォルト：60 秒。説明このパラメーターは、HTTP または HTTPS リスナーにのみ適用されます。バックエンドサーバーがタイムアウト期間内に応答しない場合、Global Accelerator はクライアントに HTTP 504 エラーを返します。	15
HttpVersion	string	任意	最大 HTTP バージョン。有効な値： http3：HTTP/3 http2（デフォルト）：HTTP/2 http1.1：HTTP/1.1 説明このパラメーターは、HTTPS リスナーにのみ適用されます。	http2

レスポンスフィールド

フィールド	型	説明	例
	object	リクエストに対して返されるデータ。
RequestId	string	リクエスト ID。	04F0F334-1335-436C-A1D7-6C044FE73368
ListenerId	string	作成されたリスナーの ID。	lsr-bp1bpn0kn908w4nbw****

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	Resource.QuotaFull	The resource quota is exceeded.
400	ProtocalIllegal.Listener	The specified listener protocol is invalid.	The specified listener protocol is invalid.
400	NotExist.Accelerator	The accelerated instance does not exist.	The accelerated instance does not exist.
400	StateError.Accelerator	The state of the accelerated instance is invalid.
400	QuotaExceeded.Listener	The maximum number of listeners is exceeded.	The maximum number of listeners is exceeded.
400	QuotaExceeded.ListenerPort	The maximum number of listener ports is exceeded.	The maximum number of listener ports is exceeded.
400	NotExist.ListenerPort	listener port %s is not exist
400	PortRangeIllegal.Listener	The specified listener port range is invalid.	The specified listener port range is invalid.
400	PortRangeIllegal.Count	The hugePort listener only supports one port range.
400	PortConflict.Listener	The listener port configuration is in conflict.	The listener port configuration is in conflict.
400	PortRangeIllegal.ExceedGaAbility	The listener port range is invalid. For each accelerator instance, you can only create a listener with port range over 300 for each protocol (TCP and UDP).
400	PortRangeIllegal.UDP	UDP ports 250, 4789, and 4790 are system reserved ports.
400	SystemPort.Listener	Ports 65500-65535 are system reserved ports.
400	PortRanges.MustOne	The portRanges must be one for HTTPS and HTTP type listener.
400	SecurityPolicyId.NotNeed	No security policy ID is required for the listener.
400	SecurityPolicyIdIllegal.Listener	The listener security policy ID %s is illegal.
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.
403	Forbbiden.SubUser	You are not authorized to operate on the specified resource because your account was created by another user.
403	Forbidden	The user is not authorized to operate on the specified resource.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。