CreateLoadBalancerTCPListener による TCP リスナーの作成 - SLB

TCP リスナーを作成します。

操作説明

説明

新しく作成されたリスナーは 停止中 の状態です。リスナーを作成した後は、StartLoadBalancerListener 操作を呼び出して、ネットワークトラフィックの転送を有効化してください。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

slb:CreateLoadBalancerTCPListener

create

AccessControlList

acs:slb:{#regionId}:{#accountId}:acl/{#AclId}

*LoadBalancer

acs:slb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

slb:tag
slb:tag
slb:tag

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	Classic Load Balancer (CLB) インスタンスがデプロイされているリージョンの ID です。最新のリージョン一覧については、「リージョンとゾーン」をご参照いただくか、DescribeRegions 操作を呼び出して情報を取得してください。	cn-hangzhou
LoadBalancerId	string	必須	CLB インスタンスの ID です。	lb-bp1b6c719dfa08ex****
ListenerPort	integer	必須	CLB インスタンスが使用するフロントエンドポートです。有効な値： 1 ～ 65535。	80
BackendServerPort	integer	任意	CLB インスタンスが使用するバックエンドポートです。有効な値： 1 ～ 65535。 VServerGroupId パラメーターが設定されていない場合、このパラメーターは必須です。	80
Tag	array<object>	任意	タグです。
	object	任意
Key	string	任意	タグキーです。最大 20 個のタグキーを指定できます。タグキーは空文字列にできません。タグキーの長さは 1 ～ 64 文字で、`aliyun` または `acs:` で始めてはならず、`http://` または `https://` を含んではなりません。	TestKey
Value	string	任意	タグ値です。最大 20 個のタグ値を指定できます。タグ値は空文字列でも構いません。タグ値の長さは最大 128 文字で、`acs:` または `aliyun` で始めてはならず、`http://` または `https://` を含んではなりません。	TestValue
Bandwidth	integer	必須	リスナーの最大帯域幅です。単位：Mbit/s。有効な値： -1：トラフィック課金のインターネット向け CLB インスタンスの場合、この値を -1 に設定すると、帯域幅制限なしとなります。 1 ～ 5120：帯域幅課金のインターネット向け CLB インスタンスの場合、各リスナーの最大帯域幅を指定できます。すべてのリスナーに対して設定した最大帯域幅の合計は、CLB インスタンスの最大帯域幅を超えてはなりません。	-1
Scheduler	string	任意	スケジューリングアルゴリズムです。有効な値： wrr（デフォルト）：重みの高いバックエンドサーバーほど、より多くのリクエストを受信します。 rr：リクエストをバックエンドサーバーに順次分散します。 sch：ソース IP アドレスに基づく一貫したハッシュを指定します。同じソース IP アドレスからのリクエストは、同じバックエンドサーバーに分散されます。 tch：ソース IP アドレス、宛先 IP アドレス、ソースポート、宛先ポートの 4 つの要素に基づく一貫したハッシュを指定します。これらの 4 つの要素が一致するリクエストは、同じバックエンドサーバーに分散されます。説明 sch および tch の一貫したハッシュアルゴリズムは、パフォーマンス専有型 CLB インスタンスでのみサポートされています。	wrr
PersistenceTimeout	integer	任意	セッション維持のタイムアウト期間です。単位：秒有効な値： 0 ～ 3600 デフォルト値： 0。デフォルト値を使用した場合、システムはセッション維持を無効化します。	0
EstablishedTimeout	integer	任意	接続のタイムアウト期間です。単位：秒有効な値： 10 ～ 900。	500
HealthyThreshold	integer	任意	不健全なバックエンドサーバーが健全と見なされるまでに、ヘルスチェックに連続して合格する必要がある回数です。この場合、ヘルスステータスは fail から success に変更されます。有効な値： 2 ～ 10	4
UnhealthyThreshold	integer	任意	健全なバックエンドサーバーが不健全と見なされるまでに、ヘルスチェックに連続して不合格となる必要がある回数です。この場合、ヘルスステータスは success から fail に変更されます。有効な値： 2 ～ 10	4
HealthCheckConnectTimeout	integer	任意	ヘルスチェック応答の最大タイムアウト期間です。単位：秒有効な値： 1 ～ 300 デフォルト値： 5	100
HealthCheckConnectPort	integer	任意	ヘルスチェックに使用するポートです。有効な値： 1 ～ 65535。このパラメーターが設定されていない場合、BackendServerPort で指定されたバックエンドポートがヘルスチェックに使用されます。	80
healthCheckInterval	integer	任意	連続する 2 回のヘルスチェックの間隔です。単位：秒。有効な値： 1 ～ 50。	3
HealthCheckDomain	string	任意	ヘルスチェックに使用するドメイン名です。有効な値： $_ip：バックエンドサーバーのプライベート IP アドレス。HealthCheckDomain パラメーターが設定されていない場合、または $_ip に設定されている場合、CLB インスタンスは各バックエンドサーバーのプライベート IP アドレスを使用してヘルスチェックを行います。 domain：ドメイン名は 1 ～ 80 文字で、英字、数字、ピリオド (.)、ハイフン (-) を含むことができます。	172.XX.XX.6
HealthCheckURI	string	任意	ヘルスチェックに使用する URI です。URI は 1 ～ 80 文字で、数字、英字、ハイフン (-)、スラッシュ (/)、ピリオド (.)、パーセント記号 (%)、シャープ (#)、アンド (&) のみを含むことができます。URI はスラッシュ (/) で始める必要がありますが、単一のスラッシュ (/) のみではいけません。 TCP リスナーで HTTP ヘルスチェックが必要な場合に、このパラメーターを設定できます。このパラメーターが設定されていない場合、TCP ヘルスチェックが実行されます。	/test/index.html
HealthCheckHttpCode	string	任意	正常なヘルスチェックの HTTP ステータスコードです。複数の HTTP ステータスコードをカンマ (,) で区切ります。有効な値： http_2xx（デフォルト） http_3xx http_4xx http_5xx	http_2xx,http_3xx
HealthCheckType	string	任意	ヘルスチェックのタイプです。有効な値： tcp（デフォルト） http	tcp
VServerGroupId	string	任意	vServer グループの ID です。	rsp-cige6j****
MasterSlaveServerGroupId	string	任意	プライマリ/セカンダリサーバーグループの ID です。説明 VServerGroupId と MasterSlaveServerGroupId の両方を設定することはできません。	rsp-0bfucw****
AclId	string	任意	リスナーに関連付けられたネットワーク ACL の ID です。説明 AclStatus を on に設定した場合、このパラメーターは必須です。	acl-uf60jwfiv6******
AclType	string	任意	ACL のタイプです。有効な値： white：ホワイトリスト。ネットワーク ACL 内の IP アドレスまたは CIDR ブロックからのリクエストのみが転送されます。ホワイトリストは、特定の IP アドレスからのアクセスのみを許可したいアプリケーションのシナリオに適用されます。ホワイトリストが適切に設定されていない場合、サービスに悪影響が出る可能性があります。ホワイトリストが設定されている場合、ホワイトリストに追加された IP アドレスからのリクエストのみがリスナーによって転送されます。ホワイトリストが設定されているが、IP アドレスがホワイトリストに追加されていない場合、リスナーはすべてのリクエストを転送します。 black：ブラックリスト。ネットワーク ACL 内の IP アドレスまたは CIDR ブロックからのすべてのリクエストが拒否されます。ブラックリストは、特定の IP アドレスからのアプリケーションへのアクセスをブロックしたいシナリオに適用されます。リスナーにブラックリストが設定されているが、IP アドレスがブラックリストに追加されていない場合、リスナーはすべてのリクエストを転送します。説明 AclStatus を on に設定した場合、このパラメーターは必須です。	black
AclStatus	string	任意	アクセスの制御を有効化するかどうかを指定します。有効な値： on：はい off（デフォルト）：いいえ	off
Description	string	任意	リスナーの名前です。名前の長さは 1 ～ 256 文字で、英字、数字、ハイフン (-)、スラッシュ (/)、ピリオド (.)、アンダースコア (_) を含むことができます。	tcp_80
ConnectionDrain	string	任意	接続ドレインを有効化するかどうかを指定します。有効な値： on：はい off：いいえ	off
ConnectionDrainTimeout	integer	任意	接続ドレインのタイムアウト期間です。単位：秒。有効な値： 10 ～ 900。説明 ConnectionDrain を on に設定した場合、このパラメーターは必須です。	300
ProxyProtocolV2Enabled	boolean	任意	Proxy プロトコルを使用してクライアント IP アドレスをバックエンドサーバーに渡すかどうかを指定します。有効な値： true：はい false（デフォルト）：いいえ	false
HealthCheckSwitch	string	任意	ヘルスチェック機能を有効化するかどうかを指定します。有効な値： on（デフォルト）：はい off：いいえ	on

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID です。	CEF72CEB-54B6-4AE8-B225-F876FF7BA984

例

成功レスポンス

JSONJSON

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidParameterValue.SpecNotSupport	The loadBalancer of shared spec does not support the parameter value, %s.
400	OperationNotSupport.Acl	The cloud box instance does not support acl.
400	InvalidParameterValue.RegionNotSupport	The region does not support the parameter value, %s.
400	Abs.VServerGroupIdAndMasterSlaveServerGroupId.MissMatch	The parameters VServerGroupId or MasterSlaveServerGroupId miss match.
400	IpVersionConflict	The ip version of this LoadBalancer and the Acl is conflict.
400	InvalidParameterValue.ZoneNotSupport	The zone does not support the parameter value, %s.
400	ListenerProcessing	A previous configuration of the listener is pending, please try again later.
400	AclNotExist	Acl does not exist.
400	InvalidParameter.ListenerPortConflict	There is conflict listener port exists.
400	InvalidParameter.ZoneNotSupport	The zone does not support the parameter %s.
400	InvalidParam.VServerGroupId	The specified VServerGroupId is invalid.
400	MissingParam.HealthCheckConnectPort	The parameter HealthCheckConnectPort is required.
400	InvalidParam.ListenerPort	The specified ListenerPort is invalid.
400	InvalidParam.StartPort	The specified StartPort is invalid.
400	InvalidParamSize.PortRange	The size of param PortRange is invalid.
400	InvalidParam.EndPort	The specified EndPort is invalid.
400	Duplicated.AclEntry	%s.
400	OperationUnsupported.SetAccessControl	The singleTunnel/anyTunnel loadbalancer does not support config AccessControlList.
400	InvalidParam.PortRange	The specified PortRange is invalid.
400	InvalidParameter.RegionNotSupport	The region does not support the parameter: %s.
400	LbNotSupportTcpssl	You cannot create a TCP SSL type listener for the specified load balancer.
400	LbSupportTcpsslOnly	The specified load balancer supports TCP SSL type listener only.
400	ListenerNotSupportRule	You cannot create a rule for the specified listener.
400	ListenerPortConflict	The specified ListenerPort is conflict with other listener.
400	ResourceNotFound.VServerGroup	%s.
400	IllegalParam.FailoverThreshold	The parameter FailoverThreshold is illegal.
400	IllegalParam.FailoverStrategy	The parameter FailoverStrategy is illegal.
400	MasterSlaveServerConflict	The servers are conflict for MasterSlaveGroup.
400	OperationDenied.HealthCheckClosedForMasterSlaveMode	The operation is denied because of HealthCheckClosedForMasterSlaveMode.
400	IllegalParam.HealthCheck	The param of HelathCheck is illegal.
400	Mismatch.SlbSpecTypeAndListenerProtocol	The SlbSpecType and ListenerProtocol are mismatched.
400	OperationDenied.FullNatModeNotAllowed	The operation is not allowed because of FullNatModeNotAllowed.
400	OperationDenied.OnlyIpv4SlbSupport	The operation is not allowed because of OnlyIpv4SlbSupport.
400	SpecNotSupportParameter	The instance with share spec does not support FullNatEnabled parameter.
400	InvalidParam.TagValue	%s.
400	InvalidParam.TagKey	%s.
400	SizeLimitExceeded.Tag	%s.
400	MissingParam.TagKey	The param MissingParam.TagKey is missing.
400	MissingParameter	The BackendServerPort or VServerGroupId is required at lease one.
400	AclListenerOverLimit	This acl has reached the limit of binding to listeners.
400	QuotaLimitExceeds.AclAttachedToListener	The number of Acl bound listeners has reached the quota limit
400	QuotaLimitExceeds.TotalAclEntry	The number of Acl entries has reached the quota limit.
400	QuotaLimitExceeds.AclListenerOverLimit	This acl has reached the limit of binding to listeners.

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

変更履歴

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