CreateListener - - Alibaba Cloud ドキュメントセンター

使用上の注意

リスナーは接続要求をリッスンし、指定されたスケジューリングアルゴリズムで定義されている転送ルールに基づいてエンドポイントに要求を配信します。このAPIを呼び出して、標準GAインスタンスのリスナーを作成できます。

この操作を呼び出す前に、次の制限事項に注意してください。

CreateListener操作は非同期です。リクエストを送信した後、システムはリクエストIDを返しますが、操作はシステムバックグラウンドで実行中です。 DescribeListener操作を呼び出して、リスナーのステータスを照会できます。
- リスナーがinit状態の場合、リスナーは作成中です。この場合、クエリ操作のみを実行できます。
- リスナーがアクティブ状態の場合、リスナーが作成されます。
指定された期間内に同じGAインスタンスに対してCreateListener操作を繰り返し呼び出すことはできません。

デバッグ

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

リクエストパラメーター


項目	データ型	必須／任意	例:	説明
操作	String	必須	CreateListener	実行する操作です。値をCreateListenerに設定します。
RegionId	String	必須	cn-hangzhou	GAインスタンスがデプロイされているリージョンのID。値をcn-hangzhouに設定します。
ClientToken	String	任意	123e4567-e89b-12d3-a456-426655440000	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用して値を生成できますが、すべてのリクエスト間で一意であることを確認する必要があります。クライアントトークンにはASCII文字のみを含めることができます。説明このパラメーターを設定しない場合、ClientTokenはRequestIdの値に設定されます。 RequestIdの値は、APIリクエストごとに異なる場合があります。
AcceleratorId	String	必須	ga-bp1odcab8tmno0hdq****	GA インスタンスの ID です。
名前	String	任意	リスナー	リスナーの名前を示します。名前は2 ~ 128文字で、英数字、アンダースコア (_) 、ハイフン (-) を使用できます。先頭は英字とする必要があります。
説明	String	任意	Listener	リスナーの説明です。説明の長さは最大で200文字です。
ClientAffinity	String	任意	SOURCE_IP	リスナーのクライアントアフィニティを有効にするかどうかを指定します。このパラメーターを空のままにすると、クライアントアフィニティは無効になります。クライアントアフィニティが無効になっている場合、同じクライアントからのリクエストが常に同じエンドポイントに転送されるとは限りません。クライアントアフィニティを有効にするには、このパラメーターをSOURCE_IPに設定します。この場合、クライアントがステートフルアプリケーションにアクセスすると、同じクライアントからの要求は、送信元ポートまたはプロトコルに関係なく、常に同じエンドポイントに転送されます。
プロトコル	String	任意	tcp	リスナーが使用するネットワーク伝送プロトコル。有効な値： tcp: TCP udp: UDP http: HTTP https: HTTPS
ProxyProtocol	Boolean	いいえ	false	クライアントIPアドレスを予約するかどうかを指定します。有効な値： true: 機能を有効にします。クライアントIPアドレスが予約された後、バックエンドサービスを介してクライアントのソースIPアドレスを表示できます。 false (デフォルト): 機能を無効にします。説明このパラメーターは、リスナーの構成に使用されるAPI操作から廃止されます。 API操作を呼び出してエンドポイントグループを設定するときに、このパラメーターを設定することを推奨します。 ProxyProtocolパラメーターの詳細については、「CreateEndpointGroup」および「UpdateEndpointGroup」をご参照ください。
PortRanges.N.FromPort	Integer	〇	20	リクエストを受信してエンドポイントに転送するために使用されるリスニングポートの範囲内の最初のポート。有効な値: 1〜65499。 FromPortの値は、ToPortの値以下である必要があります。設定できるポートの最大数は、リスナーのルーティングタイプとプロトコルによって異なります。詳細については、「リスニングポート」をご参照ください。説明 HTTPまたはHTTPSリスナーに設定できるリスニングポートは1つだけです。この場合、最初のポートが最後のポートともなる。
PortRanges.N.ToPort	Integer	〇	20	リクエストを受信してエンドポイントに転送するために使用されるリスニングポートの範囲の最後のポート。有効な値: 1〜65499。 FromPortの値は、ToPortの値以下である必要があります。設定できるポートの最大数は、リスナーのルーティングタイプとプロトコルによって異なります。詳細については、「リスニングポート」をご参照ください。説明 HTTPまたはHTTPSリスナーに設定できるリスニングポートは1つだけです。この場合、最初のポートが最後のポートともなる。
証明書. N.Id	String	任意	449 ****-cn-hangzhou	SSL証明書のID。説明このパラメーターは、HTTPSリスナーが作成された場合にのみ必要です。
XForwardedForConfig	オブジェクト	いいえ		`XForward`ヘッダーの設定。
XForwardedForGaIdEnabled	Boolean	いいえ	false	`GA-ID`ヘッダーを使用してGAインスタンスのIDを取得するかどうかを指定します。有効な値： true: はい false (デフォルト): いいえ説明このパラメーターは、HTTPおよびHTTPSリスナーに対してのみ設定できます。
XForwardedForGaApEnabled	Boolean	いいえ	false	`GA-AP`ヘッダーを使用してアクセラレーションリージョンに関する情報を取得するかどうかを指定します。有効な値： true: はい false (デフォルト): いいえ説明このパラメーターは、HTTPおよびHTTPSリスナーに対してのみ設定できます。
XForwardedForProtoEnabled	Boolean	いいえ	false	`GA-X-Forward-Proto`ヘッダーを使用してGAインスタンスのリスナープロトコルを取得するかどうかを指定します。有効な値： true: はい false (デフォルト): いいえ説明このパラメーターは、HTTPおよびHTTPSリスナーに対してのみ設定できます。
XForwardedForPortEnabled	Boolean	いいえ	false	`GA-X-Forward-Port`ヘッダーを使用してGAインスタンスのリスニングポートを取得するかどうかを指定します。有効な値： true: はい false (デフォルト): いいえ説明このパラメーターは、HTTPおよびHTTPSリスナーに対してのみ設定できます。
XRealIpEnabled	Boolean	いいえ	false	`X-Real-IP`ヘッダーを使用してクライアントIPアドレスを取得するかどうかを指定します。有効な値： 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: カスタムルーティング説明カスタムルーティングリスナーは招待プレビュー中です。カスタムルーティングリスナーを使用するには、チケットを起票してください。両方のタイプのリスナーを同じGAインスタンスに同時に設定することはできません。リスナーの作成後、ルーティングタイプを変更することはできません。詳細については、「リスナーの概要」をご参照ください。
N.EndpointGroupName	String	任意	test	インテリジェントルーティングリスナーに関連付けられているエンドポイントグループの名前。名前は2 ~ 128文字で、英数字、アンダースコア (_) 、ハイフン (-) を使用できます。先頭は英字とする必要があります。最大10個のエンドポイントグループの名前を入力できます。説明 TypeパラメーターがStandardに設定されている場合にのみ、インテリジェントルーティングリスナーのエンドポイントグループとエンドポイントを設定できます。
N.EndpointGroupDescription EndpointGroupDescription	String	任意	test	インテリジェントルーティングリスナーに関連付けられているエンドポイントグループの説明。説明の長さは256文字を超えることはできません。また、`http://` または`https://` は使用できません。最大10個のエンドポイントグループの説明を入力できます。説明 TypeパラメーターがStandardに設定されている場合にのみ、インテリジェントルーティングリスナーのエンドポイントグループとエンドポイントを設定できます。
N.EndpointGroupRegion. EndpointGroupRegion	String	任意	cn-hangzhou	インテリジェントルーティングリスナーに関連付けられているエンドポイントグループのリージョンID。最大10個のエンドポイントグループのリージョンIDを入力できます。説明 TypeパラメーターがStandardに設定されている場合にのみ、インテリジェントルーティングリスナーのエンドポイントグループとエンドポイントを設定できます。
N.TrafficPercentage EndpointGroupConfigurations.	Long	いいえ	100	トラフィック分布率。インテリジェントルーティングリスナーが複数のエンドポイントグループに関連付けられている場合、このパラメーターを設定して、比率に基づいてエンドポイントグループにトラフィックを分散できます。有効な値: 1〜100。デフォルト値: 100 最大10個のエンドポイントグループのトラフィック分散率を指定できます。説明 TypeパラメーターがStandardに設定されている場合にのみ、インテリジェントルーティングリスナーのエンドポイントグループとエンドポイントを設定できます。
EndpointGroupConfigurations.N.HealthCheckEnabled	Boolean	いいえ	false	エンドポイントグループのヘルスチェックを有効にするかどうかを指定します。有効な値： true: ヘルスチェック機能を有効にします。 false (デフォルト): ヘルスチェック機能を無効にします。最大10個のエンドポイントグループに対してヘルスチェック機能を有効にできます。説明 TypeパラメーターがStandardに設定されている場合にのみ、インテリジェントルーティングリスナーのエンドポイントグループとエンドポイントを設定できます。
N.HealthCheckIntervalSeconds	Long	いいえ	3	ヘルスチェックが実行される間隔。単位：秒。ヘルスチェック間隔は最大10回まで指定できます。説明 TypeパラメーターがStandardに設定されている場合にのみ、インテリジェントルーティングリスナーのエンドポイントグループとエンドポイントを設定できます。
EndpointGroupConfigurations.N.HealthCheckPath	String	任意	/healthcheck	システムがヘルスチェックを実行するパス。ヘルスチェックパスは最大10個まで指定できます。説明 TypeパラメーターがStandardに設定されている場合にのみ、インテリジェントルーティングリスナーのエンドポイントグループとエンドポイントを設定できます。
N.HealthCheckPort EndpointGroupConfigurations.	Long	いいえ	20	ヘルスチェックに使用されるポート。有効な値: 1〜65535。ヘルスチェックには最大10個のポートを指定できます。説明 TypeパラメーターがStandardに設定されている場合にのみ、インテリジェントルーティングリスナーのエンドポイントグループとエンドポイントを設定できます。
N.HealthCheckProtocol EndpointGroupConfigurations	String	任意	tcp	ヘルスチェック要求が送信されるプロトコル。有効な値： tcp: TCP http: HTTP https: HTTPS ヘルスチェックプロトコルは最大10個まで指定できます。説明 TypeパラメーターがStandardに設定されている場合にのみ、インテリジェントルーティングリスナーのエンドポイントグループとエンドポイントを設定できます。
N.ThresholdCount EndpointGroupConfigurations.	Long	いいえ	3	正常なエンドポイントグループが正常でないと見なされる前に発生する必要がある連続したヘルスチェックの失敗の数、または正常でないエンドポイントグループが正常であると見なされる前に発生する必要がある連続したヘルスチェックの成功の数。有効な値: 2〜10。デフォルト値: 3 最大10個のエンドポイントグループに対して、連続したヘルスチェックの成功または失敗の数を指定できます。説明 TypeパラメーターがStandardに設定されている場合にのみ、インテリジェントルーティングリスナーのエンドポイントグループとエンドポイントを設定できます。
N.EndpointConfigurations.N. タイプ	String	任意	IP	インテリジェントルーティングリスナーのエンドポイントタイプ。有効な値：ドメイン: カスタムドメイン名 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) バケットインテリジェントルーティングリスナーのエンドポイントグループには、最大で100のエンドポイントタイプを指定できます。説明 [タイプ] パラメーターが [標準] に設定されている場合、インテリジェントルーティングリスナーのエンドポイントグループとエンドポイントを設定できます。このパラメーターは必須です。このパラメーターをECSまたはSLBに設定し、サービスにリンクされたロールAliyunServiceRoleForGaVpcEndpointが存在しない場合、システムはサービスにリンクされたロールを自動的に作成します。このパラメーターをALBに設定し、サービスにリンクされたロールAliyunServiceRoleForGaAlbが存在しない場合、システムはサービスにリンクされたロールを自動的に作成します。このパラメーターをOSSに設定し、サービスにリンクされたロールAliyunServiceRoleForGaOssが存在しない場合、システムはサービスにリンクされたロールを自動的に作成します。詳細については、「サービスにリンクされたロール」をご参照ください。
N.EndpointConfigurations.N.Weight	Long	いいえ	20	The weight of the endpoint that is associated with the intelligent routing listener. 有効な値: 0〜255。インテリジェントルーティングリスナーのエンドポイントグループには、最大で100個のエンドポイントの重みを設定できます。説明 [タイプ] パラメーターが [標準] に設定されている場合、インテリジェントルーティングリスナーのエンドポイントグループとエンドポイントを設定できます。このパラメーターは必須です。エンドポイントの重みが0に設定されている場合、GAはエンドポイントへのネットワークトラフィックの配信を停止します。操作は慎重に行ってください。
N.EndpointConfigurations.N. エンドポイント	String	任意	47.0.XX.XX	インテリジェントルーティングリスナーに関連付けられているエンドポイントのIPアドレスまたはドメイン名。インテリジェントルーティングリスナーのエンドポイントグループには、最大で100のエンドポイントIPアドレスまたはドメイン名を指定できます。説明 If the Type parameter is set to Standard, you can configure endpoint groups and endpoints for an intelligent routing listener, and this parameter is required.
N.EndpointRequestProtocol. EndpointGroupConfigurations.	String	任意	HTTP	インテリジェントルーティングリスナーに関連付けられているエンドポイントのバックエンドサービスプロトコル。有効な値： HTTP (デフォルト): HTTP HTTPS: HTTPS 最大10個のバックエンドサービスプロトコルを指定できます。説明 TypeパラメーターがStandardに設定されている場合にのみ、インテリジェントルーティングリスナーのエンドポイントグループとエンドポイントを設定できます。このパラメーターは、HTTPおよびHTTPSインテリジェントルーティングリスナーに対してのみ設定できます。 HTTPリスナーの場合、バックエンドサービスプロトコルはHTTPである必要があります。
N.EndpointGroupType	String	任意	default	インテリジェントルーティングリスナーのエンドポイントグループタイプ。有効な値： default: a default endpoint group. デフォルト値です。 virtual: 仮想エンドポイントグループ。最大10個のエンドポイントグループのタイプを指定できます。説明 TypeパラメーターがStandardに設定されている場合にのみ、インテリジェントルーティングリスナーのエンドポイントグループとエンドポイントを設定できます。 Only HTTP and HTTPS intelligent routing listeners support virtual endpoint groups.
EndpointGroupConfigurations.N.PortOverrides.N.ListenerPort	Long	いいえ	443	エンドポイントポートにマップされているリスニングポート。最大5つのポートマッピングでリスニングポートを指定できます。説明 TypeパラメーターがStandardに設定されている場合にのみ、インテリジェントルーティングリスナーのエンドポイントグループとエンドポイントを設定できます。 HTTPおよびHTTPSインテリジェントルーティングリスナーのみがポートマッピングをサポートしています。ポートマッピングのリスニングポートは、現在のリスナーが使用するポートである必要があります。
N.PortOverrides.N.EndpointPort	Long	いいえ	80	リスニングポートにマップされているエンドポイントポート。最大5つのポートマッピングでエンドポイントポートを指定できます。説明 TypeパラメーターがStandardに設定されている場合にのみ、インテリジェントルーティングリスナーのエンドポイントグループとエンドポイントを設定できます。 HTTPおよびHTTPSインテリジェントルーティングリスナーのみがポートマッピングをサポートしています。
N.EnableClientIPPreservationToa EndpointGroupConfigurations.	Boolean	いいえ	false	TOA（TCP Option Address）モジュールを使って、エンドポイントにアクセスするクライアントのIPアドレスを取得し、保持するかどうかを指定します。有効な値： true: はい false (デフォルト): いいえこのパラメーターは、最大10個のエンドポイントグループに設定できます。説明 TypeパラメーターがStandardに設定されている場合にのみ、インテリジェントルーティングリスナーのエンドポイントグループとエンドポイントを設定できます。
N.EnableClientIPPreservationProxyProtocol EndpointGroupConfigurations.	Boolean	いいえ	false	プロキシプロトコルを使用してクライアントIPアドレスを保持するかどうかを指定します。有効な値： true: はい false (デフォルト): いいえこのパラメーターは、最大10個のエンドポイントグループに設定できます。説明 TypeパラメーターがStandardに設定されている場合にのみ、インテリジェントルーティングリスナーのエンドポイントグループとエンドポイントを設定できます。
N.EndpointGroupRegion. CustomRoutingEndpointGroupConfigurations	String	任意	cn-hangzhou	カスタムルーティングリスナーに関連付けられているエンドポイントグループのリージョンID。最大5つのエンドポイントグループのリージョンIDを入力できます。説明 TypeパラメーターがCustomRoutingに設定されている場合にのみ、カスタムルーティングリスナーのエンドポイントグループとエンドポイントを設定できます。
CustomRoutingEndpointGroupConfigurations.N.Name	String	任意	test	カスタムルーティングリスナーに関連付けられているエンドポイントグループの名前。名前は2 ~ 128文字で、英数字、アンダースコア (_) 、ハイフン (-) を使用できます。先頭は英字とする必要があります。最大5つのエンドポイントグループの名前を入力できます。説明 TypeパラメーターがCustomRoutingに設定されている場合にのみ、カスタムルーティングリスナーのエンドポイントグループとエンドポイントを設定できます。
CustomRoutingEndpointGroupConfigurations.N.Description	String	任意	test	カスタムルーティングリスナーに関連付けられているエンドポイントグループの説明。説明の長さは256文字を超えることはできません。また、`http://` または`https://` は使用できません。最大5つのエンドポイントグループの説明を入力できます。説明 TypeパラメーターがCustomRoutingに設定されている場合にのみ、カスタムルーティングリスナーのエンドポイントグループとエンドポイントを設定できます。
CustomRoutingEndpointGroupConfigurations.N.DestinationConfigurations.N.Protocols.N	String	任意	tcp	カスタムルーティングリスナーに関連付けられているエンドポイントグループのバックエンドサービスプロトコル。有効な値： tcp: TCP udp: UDP tcp、udp :TCPおよびUDP カスタムルーティングリスナーのエンドポイントグループには、最大4つのプロトコルタイプを指定できます。説明 TypeパラメーターがCustomRoutingに設定されている場合にのみ、カスタムルーティングリスナーのエンドポイントグループとエンドポイントを設定できます。
N.DestinationConfigurations.N.FromPort	Integer	いいえ	80	カスタムルーティングリスナーに関連付けられているエンドポイントグループのバックエンドサービスの最初のポート。有効な値: 1〜65499。 FromPortの値は、ToPortの値以下である必要があります。カスタムルーティングリスナーのエンドポイントグループには、最大20個のバックエンドサービスの最初のポートを指定できます。説明 TypeパラメーターがCustomRoutingに設定されている場合にのみ、カスタムルーティングリスナーのエンドポイントグループとエンドポイントを設定できます。
N.DestinationConfigurations.N.ToPort	Integer	いいえ	80	カスタムルーティングリスナーに関連付けられているエンドポイントグループのバックエンドサービスの最後のポート。有効な値: 1〜65499。 FromPortの値は、ToPortの値以下である必要があります。カスタムルーティングリスナーのエンドポイントグループには、最大20個のバックエンドサービスの最終ポートを指定できます。説明 TypeパラメーターがCustomRoutingに設定されている場合にのみ、カスタムルーティングリスナーのエンドポイントグループとエンドポイントを設定できます。
N.EndpointConfigurations.N. タイプ	String	任意	PrivateSubNet	カスタムルーティングリスナーに関連付けられているエンドポイントのバックエンドサービスタイプ。値を PrivateSubNet。プライベートCIDRブロックを指定します。説明 TypeパラメーターがCustomRoutingに設定されている場合にのみ、カスタムルーティングリスナーのエンドポイントグループとエンドポイントを設定できます。
N.EndpointConfigurations.N.EndpointConfigurations.N.Endpoint	String	任意	vsw-test01	カスタムルーティングリスナーのエンドポイントvSwitchの名前。説明 TypeパラメーターがCustomRoutingに設定されている場合にのみ、カスタムルーティングリスナーのエンドポイントグループとエンドポイントを設定できます。
N.EndpointConfigurations.N.TrafficToEndpointPolicy	String	任意	DenyAll	カスタムルーティングリスナーに関連付けられているエンドポイントのバックエンドサービスのトラフィックポリシー。有効な値： DenyAll (デフォルト): 指定されたバックエンドサービスへのすべてのトラフィックを拒否します。 AllowAll: 指定されたバックエンドサービスへのすべてのトラフィックを許可します。 AllowCustom: 指定した宛先へのトラフィックを許可します。宛先のIPアドレスとポート範囲を指定する必要があります。ポート範囲が空の場合、すべてのポートが使用可能です。説明 TypeパラメーターがCustomRoutingに設定されている場合にのみ、カスタムルーティングリスナーのエンドポイントグループとエンドポイントを設定できます。
N.EndpointConfigurations.N.PolicyConfigurations.N.Address	String	任意	10.0.XX.XX	トラフィックを許可する宛先のIPアドレス。このパラメーターは、TrafficToEndpointPolicyがAllowCustomに設定されている場合にのみ有効です。カスタムルーティングリスナーの各エンドポイントに最大20個の宛先IPアドレスを指定できます。説明 TypeパラメーターがCustomRoutingに設定されている場合にのみ、カスタムルーティングリスナーのエンドポイントグループとエンドポイントを設定できます。
CustomRoutingEndpointGroupConfigurations.N.EndpointConfigurations.N.PolicyConfigurations.N.PortRanges.N.FromPort	Integer	いいえ	80	トラフィックを許可する宛先のポート範囲の最初のポート。このパラメーターの値は、バックエンドサービスのポート範囲内にある必要があります。このパラメーターは、TrafficToEndpointPolicyがAllowCustomに設定されている場合にのみ有効です。カスタムルーティングリスナーの各エンドポイントに最大20の宛先ポート範囲を指定できます。宛先ごとに最大5つの最初のポートを指定できます。説明 TypeパラメーターがCustomRoutingに設定されている場合にのみ、カスタムルーティングリスナーのエンドポイントグループとエンドポイントを設定できます。
CustomRoutingEndpointGroupConfigurations.N.EndpointConfigurations.N.PolicyConfigurations.N.PortRanges.N.ToPort	Integer	いいえ	80	トラフィックを許可する宛先のポート範囲の最後のポート。このパラメーターの値は、バックエンドサービスのポート範囲内にある必要があります。このパラメーターは、TrafficToEndpointPolicyがAllowCustomに設定されている場合にのみ有効です。カスタムルーティングリスナーの各エンドポイントに最大20の宛先ポート範囲を指定できます。宛先ごとに最大5つの最後のポートを指定できます。説明 TypeパラメーターがCustomRoutingに設定されている場合にのみ、カスタムルーティングリスナーのエンドポイントグループとエンドポイントを設定できます。

レスポンスパラメーター


項目	データ型	例:	説明
RequestId	String	04F0F334-1335-436C-A1D7-6C044FE73368	リクエストの ID です。
ListenerId	String	lsr-bp1bpn0kn908w4nbw****	リスナーの ID を示します。

例

リクエストの例

http(s)://[Endpoint]/?Action=CreateListener
&RegionId=cn-hangzhou
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&AcceleratorId=ga-bp1odcab8tmno0hdq ****
&名前=リスナー
&Description=リスナー
&ClientAffinity=SOURCE_IP
&プロトコル=tcp
&ProxyProtocol=false
&PortRanges=[{"FromPort":20,"ToPort":20}]
&Certificates=[{"Id":"449 ****-cn-hangzhou"}]
&XForwardedForConfig={"XForwardedForGaIdEnabled":false、"XForwardedForGaApEnabled":false、"XForwardedForProtoEnabled":false、"XForwardedForPortEnabled":false、"XRealIpEnabled":false}
&SecurityPolicyId=tls_cipher_policy_1_0
&タイプ=標準
&EndpointGroupConfigurations=[{"EndpointGroupName":"test" 、"EndpointGroupDescription":"test" 、"EndpointGroupRegion":"cn-hangzhou" 、"TrafficPercentage":100、"HealthCheckEnabled":"healthcheck" 、":" healthcheck "" 、":" /"Health" Protocol" "" "" "、" 、"、" 、"?"? "?"? "/"? "?"? "EndpointConfigurations":[{"Type":"Ip" 、"Weight":20、"Endpoint":"47.0.XX.XX"}] 、"EndpointRequestProtocol":"HTTP" 、"EndpointGroupType":"default" 、"PortOverrides":[{"ListenerPort":443、"EndpointPort" Presor ":80" Proxiap ")"; "プロトコル:"; "Enxyipelp;" プロトコル: "Enxyal;" false}]
&CustomRoutingEndpointGroupConfigurations=[{"EndpointGroupRegion":"cn-hangzhou","Name":"test","Description":"test","DestinationConfigurations":["tcp"],"FromPort":80 "," EndpointGroupRegion "" vsw-test01 "、" TrafficToEndpointPolicy ":" DenyAll "、" PolicyConfigurations ":[{" Address ":" 10.0.XX.XX "、" PortRanges ":[{" FromPort ":80," ToPort ":80}]}]}]}]
&共通リクエストパラメータ

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

XML 形式

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

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

JSON 形式

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

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

エラーコード


HttpCode	エラーコード	エラーメッセージ	説明
400	ProtocalIllegal.Listener	指定されたリスナープロトコルは無効です。	指定されたリスナーのプロトコルが無効な場合に返されるエラーメッセージ。
400	NotExist.Accelerator	高速化されたインスタンスは存在しません。	指定されたGAインスタンスが存在しない場合に返されるエラーメッセージ。
400	QuotaExceeded.Listener	リスナーの最大数を超えています。	リスナーの数が上限に達した場合に返されるエラーメッセージ。
400	QuotaExceeded.ListenerPort	リスナーポートの最大数を超えています。	リスナーポートの数が上限に達した場合に返されるエラーメッセージ。
400	PortRangeIllegal. リスナー	指定されたリスナーポート範囲は無効です。	指定されたポート範囲が無効な場合に返されるエラーメッセージ。
400	PortRangeIllegal。カウント	hugePortリスナーは1つのポート範囲のみをサポートします。	300を超えるポートをサポートするリスナーに対して1つのポート範囲しか指定できない場合に返されるエラーメッセージ。
400	PortConflict.Listener	リスナーポートの設定が競合しています。	指定されたリスナーポートの構成が別のリスナーポートの構成と競合する場合に返されるエラーメッセージ。
400	PortRangeIllegal.ExceedGaAbility	リスナーポート範囲が無効です。アクセラレータインスタンスごとに、プロトコル (TCPおよびUDP) ごとに300を超えるポート範囲を持つリスナーのみを作成できます。	リスナーのポート範囲が無効な場合に返されるエラーメッセージ。 GAインスタンスごとに、300を超えるポート範囲を持つTCPリスナーとUDPリスナーを1つだけ作成できます。
400	PortRangeIllegal.UDP	UDPポート250、4789、4790はシステム予約ポートです。	UDPリスナーのポート250、4789、または4790を指定できない場合に返されるエラーメッセージ。それらはシステムによって予約されます。
400	SystemPort.Listener	ポート65500〜65535は、システム予約ポートである。	65535 65500のポートがシステムによって予約されている場合に返されるエラーメッセージ。
400	PortRanges.MustOne	portRangesはHTTPSとHTTPタイプのリスナーの1つである必要があります。	HTTPまたはHTTPSリスナーが1つのポートのみをサポートしている場合に返されるエラーメッセージ。
400	SecurityPolicyId.NotNeed	リスナーにはセキュリティポリシーIDは必要ありません。	現在のリスナーにセキュリティポリシーIDを指定する必要がない場合に返されるエラーメッセージ。
400	SecurityPolicyIdIllegal.Listener	リスナーのセキュリティポリシーID % sは不正です。	セキュリティポリシーのIDが無効な場合に返されるエラーメッセージ。

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