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

注 リスナーは作成された時点のステータスは stopped です。 リスナーが作成された後、 StartLoadBalancerListener を呼び出す必要があります。トラフィックを転送するためにリスナーを起動する API です。

デバッグ

API の呼び出し、SDK コード例の生成、デバッグ操作の実行、および API の検索は OpenAPI Explorer を使用することを推奨します。

リクエストパラメータ

パラメータ データ型 必須/省略可能 値の例 説明
Action String 必須 CreateLoadBalancerTCPListener

この操作の名前です。 値 ：Createloadbalancertcplistener
Bandwidth Integer 省略可能 -1

リスナーのピーク帯域幅です。 有効値： -1 | 1〜5120。

  • -1：トラフィックで課金されるインターネットインスタンスに治してピーク帯域幅を -1 に設定できます。 したがって、ピーク帯域幅は無制限です。
  • 1〜5120 (Mbit / 秒)：帯域幅によって課金されるインターネットインスタンスの場合、リスナーごとに 1 つのピーク帯域幅を設定できます。 全リスナーの合計ピーク帯域幅は、インスタンスのピーク帯域幅を超えることはできません。
ListenerPort Integer 必須 80

SLB インスタンスに使用されるフロントエンドポートです。 値の範囲： 1〜65535

LoadBalancerId String 必須 lb-bp1b6c719dfa08exfuca5

SLB インスタンスの ID です。

RegionId String 必須 cn-hangzhou

SLB インスタンスが属するリージョンです。

リージョ ID を照会するには、 リージョンとゾーンのリスト または DescribeRegions API を呼び出します。

AclId String 省略可能 1323

任意。 アクセス制御リストをホワイトリストやブラックリストとして選択します。

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

AclStatus String 省略可能 off

任意。 アクセス制御を有効にするかどうかを示します。

有効値： on | off デフォルト値：off

AclType String 省略可能 black

任意。 アクセス制御のタイプ：

  • white：ホワイトリストを示します。 アクセス制御リストで特定した IP アドレスや CIDR ブロックからのリクエストのみが転送されます。 アプリケーションが特定の IP アドレスからのアクセスのみを許可するシナリオに適用されます。
ホワイトリストを有効にすると、サービスにリスクが発生します。

ホワイトリストの設定後、リスト内の IP アドレスのみがリスナーにアクセスできます。

リストに IP アドレスを追加せずにホワイトリストを有効にした場合、リクエストは転送されません。

  • black：ブラックリストを示します。 選択したアクセス制御リスト内の IP アドレスまたは CIDR ブロックからの要求は転送されません (つまり、それらはブロックされます)。 特定の IP アドレスからのアクセスのみをアプリケーションで拒否するシナリオに利用します。
リストに IP アドレスを追加せずにブラックリストを有効にすると、すべてのリクエストが

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

BackendServerPort Integer 省略可能 80

任意。 SLB インスタンスに使用されるフロントエンドポートです。 値の範囲： 1〜65535 。

VServerGroupId パラメータが指定されない場合、このパラメータが必要です。

Description String 省略可能 TCP リスナーを作成します。

任意。 リスナーの説明です。

説明の長さは 1〜80 文字で、文字、数字、ハイフン ( - )、スラッシュ ( / )、ピリオド ( . )、アンダーライン ( _ ) を使用できます。 漢字がサポートされています。

EstablishedTimeout Integer 省略可能 500

任意。 接続タイムアウト。 値の範囲： 10 ～900。 単位：秒

HealthCheckConnectPort Integer 省略可能 80

任意。 ヘルスチェックに使用されるポートです。 値の範囲： 1〜65535

このパラメータを設定しない場合は、バックエンドサービスポート (BackendServerPort) が使用されます。

HealthCheckConnectTimeout Integer 省略可能 100

任意。 ヘルスチェックレスポンスごとの最大タイムアウト値です。 値の範囲： 1〜300 単位：秒

デフォルト値：5

HealthCheckDomain String 省略可能 $ _ip

任意。 ヘルスチェックに使用されるドメイン名です。 有効値：

  • $ _ip：バックエンドサーバーのプライベート IP アドレスです。 IP アドレスが指定されているか、またはこのパラメータが指定されていない場合、SLB はヘルスチェックのドメイン名としてバックエンドサーバーのプライベート IP アドレスを使用します。
  • ドメイン：ドメイン名の長さは 1-80 文字で、英字、数字、ピリオド ( . )、ハイフン ( - ) のみを含むことができます。
HealthCheckHttpCode String 省略可能 http_2xx、http_3xx

任意。 ヘルスチェックが正常であるかどうかを示すHTTPステータスコードです。 カンマで複数の HTTP ステータスを区切ります。

有効値： http_2xx | http_3xx | http_4xx | http_5xx。 デフォルト値：http_2xx

HealthCheckType String 省略可能。 tcp

任意。 ヘルスチェックタイプ 有効値： tcp | http。 デフォルト値：10。

HealthCheckURI String 省略可能 /test/index.html

任意。 ヘルスチェックに使用される URI です。

TCP リスナーが HTTP ヘルスチェックを必要とするときに、このパラメータを設定できます。 このパラメータを設定しないと、TCP ヘルスチェックが実行されます。

HealthyThreshold Integer 省略可能 4

任意。 バックエンドサーバーの異常が示されるまでにヘルスチェックが連続して成功した回数です (失敗から 成功状態への 変化)。

値の範囲： 2〜10

MasterSlaveServerGroupId String 省略可能 rsp-0bfucwuotx

任意。 アクティブ/スタンバイサーバーグループの ID です。

注 VServerGroupId または MasterSlaveServerGroupId のいずれかを選択できます。
PersistenceTimeout Integer 省略可能 0

任意。 セッション持続のタイムアウト値です。 値の範囲： 0〜3600 単位：秒

既定値： 0 です。 これは、セッション持続性が無効になっていることを示します。

Scheduler String 省略可能 wrr

任意。 トラフィックを配信するために使用されるアルゴリズムです。 有効値： wrr | wlc | rr

  • wrr (デフォルト値)：重みの大きいバックエンドサーバーはポーリングされる可能性が高くなります。
  • wlc：重みが大きいサーバーほど、より多くのリクエストを受け取ります。
重みの値が同じ場合、接続数の少ないバックエンドサーバーの方が、より頻繁に (そして高い確率で) アクセスされます。
  • rr：リクエストは、バックエンドサーバーに均等かつ順番に配信されます。
UnhealthyThreshold Integer 省略可能 4

任意。 バックエンドサーバーの異常が示されるまでにヘルスチェックが連続して失敗した回数です ( 成功 から 失敗状態への変化)。

値の範囲：2〜10
VServerGroupId String 省略可能 rsp-cige6j5e7p

任意。 VServer グループの ID です。

healthCheckInterval Integer 省略可能 3

任意。 連続した 2 回のヘルスチェックの時間間隔です。 値の範囲： 1〜50 単位：秒

レスポンスパラメータ

パラメータ データ型 値の例 説明
RequestId String CEF72CEB-54B6-4AE8-B225-F876FF7BA984

リクエストの ID です。

例

リクエストの例





http(s)://[Endpoint]/? Action=CreateLoadBalancerTCPListener
&Bandwidth=-1
&ListenerPort=80
&LoadBalancerId=lb-bp1b6c719dfa08exfuca5
&<CommonParameters>

レスポンスの例

XML 形式 

<CreateLoadBalancerTCPListenerResponse>
  <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
</CreateLoadBalancerTCPListenerResponse>

JSON 形式 

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

エラーコード

HttpCode エラーコード エラーメッセージ 説明
400 Abs.VServerGroupIdAndMasterSlaveServerGroupId.MissMatch The parameters VServerGroupId or MasterSlaveServerGroupId miss match. The parameter VServerGroupId or MasterSlaveServerGroupId does not match.

一般的なエラーコードをご参照ください。