すべてのプロダクト
Search
ドキュメントセンター

ENS:CreateLoadBalancerTCPListener

最終更新日:May 07, 2026

TCP リスナーを作成するには、CreateLoadBalancerTCPListener を呼び出します。

操作説明

  • API 呼び出しレート:1 秒あたり 100 件のリクエスト。

  • ユーザーごとの呼び出しレート:1 秒あたり 10 件のリクエスト。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ens:CreateLoadBalancerTCPListener

create

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

LoadBalancerId

string

必須

ロードバランサーインスタンスの ID です。

lb-5ovkn1piwqmoqrfjdyhq4****

ListenerPort

integer

必須

バックエンドサーバーにリクエストを受信および転送するリスナーポートです。有効値:165535

80

Description

string

任意

リスナーの説明です。説明は 180 文字である必要があります。

説明

説明は http:// または https:// で開始できません。

example

Scheduler

string

任意

スケジューリングアルゴリズムです。有効値:

  • wrr(デフォルト):重み付きラウンドロビン。リクエストはバックエンドサーバーの重みに基づいて分散されます。重みが高いバックエンドサーバーほど多くのリクエストを受け取ります。

  • wlc:重み付き最小接続数。リクエストはバックエンドサーバーの重みと接続数の両方に基づいて分散されます。複数のバックエンドサーバーが同じ重みを持つ場合、接続数が最も少ないサーバーがより多くのリクエストを受け取ります。

  • rr:ラウンドロビン。リクエストはバックエンドサーバーに順番に分散されます。

  • sch:送信元 IP ハッシュ。リクエストは送信元 IP アドレスの一貫性のあるハッシュに基づいてルーティングされ、同じ送信元 IP アドレスからのリクエストが同じバックエンドサーバーに送信されるようにします。

  • tch:4 タプルハッシュ。リクエストは 4 タプル(送信元 IP アドレス、宛先 IP アドレス、送信元ポート、宛先ポート)の一貫性のあるハッシュに基づいてルーティングされ、同じフローからのリクエストが同じバックエンドサーバーに送信されるようにします。

wrr

PersistenceTimeout

integer

任意

セッション維持のタイムアウト期間です。

  • デフォルト値:0(セッション維持が無効であることを示します)。

  • 有効値:03600

  • 単位:秒。

0

EstablishedTimeout

integer

任意

確立済み接続のタイムアウト期間(秒単位)です。有効値:10900。デフォルト値:900

500

HealthyThreshold

integer

任意

バックエンドサーバーが正常(fail から success の状態)と見なされるために必要な連続したヘルスチェック成功回数です。有効値:210。デフォルト値:3

4

UnhealthyThreshold

integer

任意

バックエンドサーバーが異常(success から fail の状態)と見なされるために必要な連続したヘルスチェック失敗回数です。有効値:210。デフォルト値:3

4

HealthCheckConnectTimeout

integer

任意

ヘルスチェック応答を待つ最大時間です。このタイムアウト期間内にバックエンド ENS インスタンスが応答しない場合、ヘルスチェックは失敗します。

  • デフォルト値:5。

  • 有効値:1300

  • 単位:秒。

説明

このパラメーターの値が HealthCheckInterval の値より小さい場合、このパラメーターは無視され、HealthCheckInterval の値がタイムアウト期間として使用されます。

100

HealthCheckInterval

integer

任意

ヘルスチェックの間隔(秒単位)です。有効値:150。デフォルト値:2

3

HealthCheckDomain

string

任意

ヘルスチェックに使用するドメイン名です。

www.aliyundoc.com

HealthCheckURI

string

任意

ヘルスチェックの URI です。URI は 180 文字である必要があります。

説明

URI はスラッシュ (/) で始まる必要がありますが、スラッシュ (/) のみではいけません。

/checkpreload.htm

HealthCheckHttpCode

string

任意

ヘルスチェック成功を示す HTTP ステータスコードです。有効値:

  • http_2xx(デフォルト)

  • http_3xx

  • http_4xx

  • http_5xx

http_2xx

HealthCheckType

string

任意

ヘルスチェックタイプです。有効値:

  • tcp(デフォルト)

  • http

tcp

BackendServerPort

integer

任意

バックエンドサーバーが使用するポートです。有効値:165535

8080

HealthCheckConnectPort

integer

任意

ヘルスチェックに使用するポートです。有効値:165535。このパラメーターを指定しない場合、デフォルトで BackendServerPort で指定されたポートが使用されます。

8080

EipTransmit

string

任意

EIP パススルーを有効にするかどうかを指定します。有効値:

  • on:EIP パススルーを有効にします。

  • off(デフォルト):EIP パススルーを無効にします。

on

レスポンスフィールド

フィールド

説明

object

レスポンススキーマです。

RequestId

string

リクエスト ID です。

06F00FBB-3D9E-4CCE-9D43-1A6946A75456

成功レスポンス

JSONJSON

{
  "RequestId": "06F00FBB-3D9E-4CCE-9D43-1A6946A75456"
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 Invalid%s The specified parameter %s is invalid.
400 Missing%s You must specify the parameter %s.
400 LoadBalancerNotFound The input parameter loadBalancerId that is not found.
400 IncorrectInstanceStatus The current status of the resource does not support this operation.
400 ListenerAlreadyExists The listener already exists.
400 ens.interface.error Failed to call API.
400 NoPermission Permission denied.
400 InvalidParameter.%s The specified field %s invalid. Please check it again.

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

変更履歴

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