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

Network Load Balancer (NLB) インスタンスの TCP、UDP、または TCP/SSL リスナーを作成します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

nlb:CreateListener

create

*ServerGroup

acs:nlb:{#regionId}:{#accountId}:servergroup/{#ServerGroupId}

SecurityPolicy

acs:nlb:{#regionId}:{#accountId}:securitypolicy/{#SecurityPolicyId}

*LoadBalancer

acs:nlb:{#regionId}:{#accountId}:loadbalancer/{#LoadbalancerId}

nlb:ListenerProtocol
nlb:SecurityPolicyId

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ListenerProtocol	string	必須	リスナープロトコル。有効値：TCP、UDP、TCPSSL。	TCP
ListenerPort	integer	必須	リスナーポート。有効値：0～65535。値 0 は、すべてのポートが使用されることを示します。値を 0 に設定する場合は、StartPort と EndPort も指定する必要があります。	80
ListenerDescription	string	任意	リスナーの名前。名前は長さが 2～256 文字で、文字、数字、コンマ (,)、ピリオド (.)、セミコロン (;)、スラッシュ (/)、アットマーク (@)、アンダースコア (_)、ハイフン (-) を使用できます。	tcp_80
LoadBalancerId	string	必須	NLB インスタンスの ID。	nlb-83ckzc8d4xlp8o****
ServerGroupId	string	必須	サーバーグループの ID。説明 ListenerProtocol に TCP を選択した場合、バックエンドプロトコルが TCP または TCP_UDP のサーバーグループを選択できます。バックエンドプロトコルが UDP のサーバーグループは選択できません。 ListenerProtocol に UDP を選択した場合、バックエンドプロトコルが UDP または TCP_UDP のサーバーグループを選択できます。バックエンドプロトコルが TCP のサーバーグループは選択できません。 ListenerProtocol に TCPSSL を選択した場合、バックエンドプロトコルが TCP で、クライアント IP アドレス保持機能が無効になっているサーバーグループを選択できます。バックエンドプロトコルが TCP で、クライアント IP アドレス保持機能が有効になっているサーバーグループ、またはバックエンドプロトコルが UDP または TCP_UDP のサーバーグループは選択できません。	sgp-ppdpc14gdm3x4o****
IdleTimeout	integer	任意	アイドル接続のタイムアウト期間。単位：秒。 ListenerProtocol が TCP または TCPSSL に設定されている場合、値は 10～900 の範囲である必要があります。デフォルト値：900。 ListenerProtocol が UDP に設定されている場合、値は 10～90 の範囲である必要があります。デフォルト値：90。	900
SecurityPolicyId	string	任意	セキュリティポリシーの ID。システムセキュリティポリシーとカスタムセキュリティポリシーがサポートされています。システムポリシーの有効値：tls_cipher_policy_1_0 (デフォルト)、tls_cipher_policy_1_1、tls_cipher_policy_1_2、tls_cipher_policy_1_2_strict、tls_cipher_policy_1_2_strict_with_1_3。カスタムセキュリティポリシー：カスタムセキュリティポリシーの ID。カスタムポリシーの作成方法の詳細については、「CreateSecurityPolicy」をご参照ください。セキュリティポリシーのクエリ方法の詳細については、「ListSecurityPolicy」をご参照ください。説明このパラメーターは TCP/SSL リスナーに対してのみ有効です。	tls_cipher_policy_1_0
CertificateIds	array	任意	サーバー証明書。このパラメーターは TCP/SSL リスナーに対してのみ有効です。説明サーバー証明書は 1 つのみ指定できます。
	string	任意	サーバー証明書。このパラメーターは TCP/SSL リスナーに対してのみ有効です。説明サーバー証明書は 1 つのみ指定できます。	123157******
CaCertificateIds	array	任意	CA 証明書。このパラメーターは TCP/SSL リスナーに対してのみ有効です。説明 CA 証明書は 1 つのみ指定できます。
	string	任意	CA 証明書。このパラメーターは TCP/SSL リスナーに対してのみ有効です。説明 CA 証明書は 1 つのみ指定できます。	139a00******
CaEnabled	boolean	任意	相互認証を有効にするかどうかを指定します。有効値： true false (デフォルト)	false
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。有効値： true：ドライランを実行します。システムは、必須パラメーター、リクエストフォーマット、およびサービス制限を確認します。リクエストがドライランに失敗した場合、エラーメッセージが返されます。リクエストがドライランに成功した場合、`DryRunOperation` エラーコードが返されます。 false (デフォルト)：通常のリクエストを実行します。リクエストがチェックに合格すると、2xx HTTP ステータスコードが返され、操作が実行されます。	false
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントトークンを作成して、異なるリクエスト間でトークンが一意であることを確認できます。トークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムは自動的にリクエストの RequestId を ClientToken として使用します。RequestId はリクエストごとに異なる場合があります。	123e4567-e89b-12d3-a456-426655440000
RegionId	string	任意	NLB インスタンスがデプロイされているリージョンの ID。 DescribeRegions 操作を呼び出して、最新のリージョンリストをクエリできます。	cn-hangzhou
ProxyProtocolEnabled	boolean	任意	Proxy Protocol を使用してクライアント IP アドレスをバックエンドサーバーに渡すかどうかを指定します。有効値： true false (デフォルト)	false
SecSensorEnabled	boolean	任意	高精度監視を有効にするかどうかを指定します。有効値： true false (デフォルト)	false
AlpnEnabled	boolean	任意	Application-Layer Protocol Negotiation (ALPN) を有効にするかどうかを指定します。有効値： true false (デフォルト)	false
AlpnPolicy	string	任意	ALPN ポリシー。有効値： HTTP1Only：HTTP 1.x のみを使用します。優先順位は HTTP 1.1 > HTTP 1.0 です。 HTTP2Only：HTTP 2.0 のみを使用します。 HTTP2Optional：HTTP 1.x を優先しますが、HTTP 2.0 もサポートします。優先順位は HTTP 1.1 > HTTP 1.0 > HTTP 2.0 です。 HTTP2Preferred：HTTP 2.0 を優先しますが、HTTP 1.x もサポートします。優先順位は HTTP 2.0 > HTTP 1.1 > HTTP 1.0 です。説明このパラメーターは、AlpnEnabled が true に設定されている場合に必須です。	HTTP1Only
StartPort	integer	任意	リスナーポート範囲の開始ポート。有効値：1～65535。説明このパラメーターは、ListenerPort が 0 に設定されている場合に必須です。	244
EndPort	integer	任意	リスナーポート範囲の終了ポート。有効値：1～65535。終了ポートの値は、開始ポートの値より大きい必要があります。説明このパラメーターは、ListenerPort が 0 に設定されている場合に必須です。	566
Cps	integer	任意	各ゾーン (VIP) のリスナーで 1 秒あたりに作成できる新しい接続の最大数。有効値：0～1000000。0 は、新しい接続の数が無制限であることを示します。	100
Mss	integer	任意	TCP パケットの最大セグメントサイズ (MSS)。単位：バイト。有効値：0～1500。0 は、TCP パケットの MSS 値が変更されないことを示します。説明このパラメーターは、TCP または TCP/SSL を使用するリスナーでのみ使用できます。	43
Tag	array<object>	任意	タグ。
	object	任意	タグ。
Key	string	任意	タグキー。タグキーは最大 64 文字で、`aliyun` または `acs:` で始めることはできません。`http://` または `https://` を含めることはできません。文字、数字、アンダースコア (_)、ピリオド (.)、コロン (:)、スラッシュ (/)、等号 (=)、プラス記号 (+)、ハイフン (-)、アットマーク (@) を含めることができます。各呼び出しで最大 20 個のタグを指定できます。	KeyTest
Value	string	任意	タグの値。タグの値は最大 128 文字で、`aliyun` または `acs:` で始めることはできません。`http://` または `https://` を含めることはできません。文字、数字、アンダースコア (_)、ピリオド (.)、コロン (:)、スラッシュ (/)、等号 (=)、プラス記号 (+)、ハイフン (-)、アットマーク (@) を含めることができます。各呼び出しで最大 20 個のタグを指定できます。	Test
ProxyProtocolV2Config	object	任意	VpcId、PrivateLinkEpId、および PrivateLinkEpsId 情報をバックエンドサーバーに伝達するための Proxy Protocol の構成。
Ppv2VpcIdEnabled	boolean	任意	Proxy Protocol を使用して VpcId をバックエンドサーバーに伝達するかどうかを指定します。有効値： true false (デフォルト)	false
Ppv2PrivateLinkEpIdEnabled	boolean	任意	Proxy Protocol を使用して Ppv2PrivateLinkEpId をバックエンドサーバーに伝達するかどうかを指定します。有効値： true false (デフォルト)	false
Ppv2PrivateLinkEpsIdEnabled	boolean	任意	Proxy Protocol を使用して PrivateLinkEpsId をバックエンドサーバーに伝達するかどうかを指定します。有効値： true false (デフォルト)	false

レスポンスフィールド

フィールド	型	説明	例
	object	RpcResponse
RequestId	string	リクエスト ID。	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
ListenerId	string	リスナー ID。	lsn-bp1bpn0kn908w4nbw****@80
JobId	string	非同期タスクの ID。	72dcd26b-f12d-4c27-b3af-18f6aed5****

例

成功レスポンス

JSONJSON

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "ListenerId": "lsn-bp1bpn0kn908w4nbw****@80",
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	Conflict.Port	The Port [%s] is conflict.	指定したポートと既存のポートが競合しています
400	IllegalParam.MssConflictWithUdpAndGeneve	The param of MssConflictWithUdpAndGeneve is illegal.
400	QuotaExceeded.%s	The quota of %s is exceeded, usage %s/%s.
400	SystemBusy	System is busy, please try again later.
400	Mismatch.VpcId	The VpcId is mismatched for %s and %s.
400	ResourceNotEnough.%s	The specified resource of %s is not enough.
400	Conflict.Lock	The Lock [%s] is conflict.	日文说明1
400	IllegalParam.AnyPortListenerConflictWithNonAnyPortServerGroup	The param of AnyPortListenerConflictWithNonAnyPortServerGroup is illegal.
400	IncorrectStatus.loadbalancer	The status of loadbalancer [%s] is incorrect.
400	ResourceNotFound.Certificate	The specified resource %s is not found.
400	IllegalParam.ServerGroupId	The param of ServerGroupId is illegal.
400	IllegalParam.NonAnyPortListenerConflictWithAnyPortServerGroup	The param of NonAnyPortListenerConflictWithAnyPortServerGroup is illegal.
400	MissingParam.Certificate	The param of certificate is missing.
400	IllegalParam.Port	The param of Port is illegal.
400	QuotaExceeded.QuotaInsufficient	The quota of %s is exceeded, usage %s/%s.
400	Mismatch.Protocol	The Protocol is mismatched for %s and %s.
400	ResourceNotEnough.CaCertificateApiCount	The specified resource of CaCertificateApiCount is not enough.
400	MissingParam.ServerGroupId	The param of ServerGroupId is missing.
400	IllegalParam.ListenerDescription	The parameter ListenerDescription of listener is illegal.
400	DryRunOperation	Request validation has been passed with DryRun flag set.	日文说明6
400	IllegalParam.IdleTimeout	The param of IdleTimeout is illegal.
400	MissingParam.%s	The parameter of %s is missing.
400	IllegalParam	The param of %s is illegal.
400	IllegalParamSize.certificateIds	The param size of certificateIds or caCertificateIds is illegal.
400	DuplicatedParam.listener	The param of any port listener is duplicated.
400	IllegalParam.PreserveClientIpSwitch	The server group associated with the tcpssl listener does not support enabling PreserveClientIp.
400	OperationDenied.RegionNotSupportHDMonitor	The operation is not allowed because of RegionNotSupportHDMonitor.
403	Forbidden.NoPermission	Authentication is failed for NoPermission.
404	ResourceNotFound.VSwitch	The specified resource of vSwitch is not found.
404	ResourceNotFound.loadBalancer	The specified resource of loadbalancer is not found.
404	ResourceNotFound.serverGroup	The specified resource of serverGroup is not found.
404	ResourceNotFound.CaCertificate	The specified resource of CaCertificate is not found.
404	ResourceNotFound.HdMonitorConfigNotExist	The specified resource of HdMonitorConfigNotExist is not found.

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

変更履歴

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