edit-icon download-icon

CreateLoadBalancerTCPListener

最終更新日: May 21, 2018

説明

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

注意: リスナーが作成されると、リスナーのステータスは停止します。StartLoadBalancerListener API を呼び出して、トラフィックを配信するリスナーを開始します。

リクエストパラメータ

名前 必須かどうか 説明
Action String はい

実行するアクション。有効な値:

CreateLoadBalancerTCPListener

RegionId String はい SLB インスタンスが配置されているリージョンの ID 。
LoadBalancerId String はい TCP リスナーが作成される SLB インスタンスの ID。
ListenerPort Integer はい

着信トラフィックを受信し、トラフィックをバックエンドサーバーに配信するために使用されるリスナーのフロントエンドポート。

有効な値: [1, 65535]

BackendServerPort Integer いいえ

リクエストを受け取るためにバックエンドサーバー上で開かれたポート。

有効な値: [1, 65535]

注意: VServerGroupId パラメータが指定されていない場合、このパラメータは必須です。

Bandwidth Integer はい

リスナーのピーク帯域幅。有効な値: [1,1000] Mbps

注意: インターネット SLB インスタンスがトラフィックによって課金されている場合は、-1に設定します。

Scheduler String いいえ

トラフィックを分散するために使用されるアルゴリズム。有効な値:

  • wrr (Default)

    より高い重みを持つバックエンドサーバーは、より小さい重みを持つものより多くのリクエストを受け取ります。

  • wlc

    重量の高いサーバーは、一度にライブ接続の割合が高くなります。ウェイトが同じ場合、システムは確立された接続が最も少ないサーバーにネットワーク接続を指示します。

  • rr

    リクエストは、バックエンドサーバに均等かつ逐次配信されます。

VServerGroupId String いいえ

VServer グループの ID。

VServerGroupId パラメータとMasterSlaveServerGroupIdパラメータは同時に使用できません。

MasterSlaveServerGroupId String いいえ

マスター/スレーブサーバーグループの ID。

The VServerGroupId パラメータとMasterSlaveServerGroupIdパラメータは同時に使用できません。

EstablishedTimeout Integer いいえ

レイヤ 4 TCP リスナーの接続タイムアウト(秒単位)。

有効な値: [10, 900]。デフォルト値は 900 です。

PersistenceTimeout Integer いいえ

TCP 接続のタイムアウト値(秒単位)。 有効な値: [10,900]

注意: デフォルトでは、この値はzeroに設定され、セッション永続性機能は無効になっています。

AclStatus Stringいいえ

アクセス制御機能を有効にするかどうかを指定します。

有効な値: on | off (デフォルト)

AclType Stringいいえ

アクセス制御機能を有効にした後、アクセス制御方式を選択します。

  • ホワイトリスト:選択したアクセス制御リストのIPアドレスまたはCIDRブロックからの要求のみが転送されます。アプリケーションが特定のIPアドレスからのアクセスのみを許可するシナリオに適用されます。

    ホワイトリストを有効にすると、ビジネス上のリスクが発生します。対応するアクセス制御リストにIPエントリを追加せずにホワイトリストを有効にすると、要求は転送されません。

  • ブラックリスト:選択したアクセス制御リストのIPアドレスまたはCIDRブロックからの要求は転送されません。アプリケーションが特定のIPアドレスからのアクセスのみを拒否するシナリオに適用されます。

    対応するアクセス制御リストにIPエントリを追加せずにブラックリストを有効にすると、すべての要求が転送されます。

このパラメータは、 AclStatus パラメータの値が on の場合に必要です。

AclId Stringいいえ

アクセスリストをホワイトリストまたはブラックリストとして選択します。詳細は、アクセス制御リストの設定を参照してください。

このパラメータは、 AclStatus パラメータの値が on の場合に必要です。

HealthCheckType String いいえ

ヘルスチェック方法を選択します。有効な値:

tcp (デフォルト) | http

HealthCheckDomain String いいえ

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

デフォルトで、Server Load Balancerは、ヘルスチェックを行うために、バックエンドECSインスタンスのイントラネットIPアドレスを使用して、アプリケーションサーバー上に構成された既定のホームページにHTTPヘッダー要求を送信します。

バックエンドサーバがホストのフィールドを確認した場合はリクエストには、必ずヘルスチェック作品を作るためにドメイン名を設定する必要があります。

ヘルスチェックを行うホストの IP アドレスは$_ip形式で指定できます。

注意: このパラメータは、HTTP ヘルスチェック方法が使用されている場合にのみ使用されます。

HealthCheckURI String いいえ

ヘルスチェックに使用される URI。

注意: このパラメータは、HTTP ヘルスチェック方法が使用されている場合にのみ使用されます。

HealthCheckConnectPort Integer いいえ

ヘルスチェックに使用されるポート。

有効な値: [1, 65535]

HealthyThreshold Integer いいえ

同一の ECS インスタンス上で同じLVSモードサーバによって実行された正常性チェックの連続成功回数(失敗から成功まで)

有効な値: [2,10]

UnhealthyThreshold Integer いいえ

同一の ECS インスタンス上で同じ LVS ノードサーバーによって実行された正常性チェックの連続失敗の回数(成功から失敗)

有効な値: [2,10]

HealthCheckTimeout Integer いいえ

ヘルスチェックからの応答を待機する時間(秒単位)。ECS インスタンスが指定されたタイムアウト時間内に応答を送信しない場合、ヘルスチェックは失敗します。

有効な値: [1,300]

注意: HealthCheckInterval の値が HealthCHeckTimeout パラメーターの値より大きい場合、タイムアウトは HealthCheckInterval パラメーターの値に設定されます。

HealthCheckInterval Integer いいえ

連続した 2 回の健康診断の時間間隔。

有効な値: [1,50]

HealthCheckHttpCode String いいえ

ヘルスチェックが正常であることを示す HTTP ステータスコード。カンマ(、)で複数の HTTP ステータスコードを区切ります。

有効な値: http_2xx (Default) | http_3xx | http_4xx | http_5xx

デフォルト: http_2xx.

注意: このパラメータは、HTTP ヘルスチェック方法が使用されている場合にのみ使用されます。

レスポンスパラメータ

名前 説明
RequestId String リクエストの ID。

リクエストの例

  1. https://slb.aliyuncs.com/?Action=CreateLoadBalancerTCPListener
  2. &LoadBalancerId=139a00604ad-cn-east-hangzhou-01
  3. &ListenerPort=80
  4. &BackendServerPort=80
  5. &Bandwidth=-1
  6. &VServerGroupId=rsp-cige6j5e7p
  7. &<CommonParameters>

レスポンスの例

  • XML 形式

    1. <?xml version="1.0" encoding="UTF-8"?>
    2. <CreateLoadBalancerTCPListenerResponse>
    3. <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
    4. </CreateLoadBalancerTCPListenerResponse>
  • JSON 形式

    1. {
    2. "RequestId":" CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
    3. }