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

注 新しく作成されたリスナーは停止した状態です。 StartLoadBalancerListener API を呼び出して、トラフィックを配信するリスナーを開始します。

デバッグ

OpenAPI Explorer を使用して、デバッグ操作を実行し、SDK コード例を生成します。

リクエストパラメータ

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

このルールの名前です。 値：CreateLoadBalancerHTTPListener

HealthCheck String 必須 on

ヘルスチェック機能を有効にするかどうかを示します。 有効な値：on | off
ListenerPort Integer いいえ 80

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

LoadBalancerId String 必須 lb-bp1c9vixxjh92q83tw1ae-cn-east-hangzhou-01

SLB インスタンスの ID です。
RegionId String 必須 cn-hangzhou

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

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

StickySession String 必須 off

セッション持続性を有効にするかどうかを示します。

有効値：on | off
AclId String 省略可能 123

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

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

AclStatus String 省略可能 off

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

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

AclType String 省略可能 white

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

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

    ホワイトリストを有効にすると、サービスにリスクが発生します。

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

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

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

    リストに IP アドレスを追加せずにブラックリストを有効にすると、すべての要求が転送されます。

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

BackendServerPort Integer 省略可能 80

任意。 SLB インスタンスに使用されるフロントエンドポートです。

値の範囲：1 ～ 65535

注 VServer グループが使用されていない場合 (VServerGroupIdパラメーターが指定されていない場合)、このパラメーターが必要です。
帯域幅 Integer 省略可能 -1

任意。 リスナーのピーク帯域幅です。 有効値：

  • -1：ピーク帯域幅は制限されません。
  • 1 ～ 5120：リスナーのピーク帯域幅です。 全リスナーの合計ピーク帯域幅は、インスタンスのピーク帯域幅を超えることはできません。
注 このパラメータは中国のサイトにのみ適用されます。
Cookie String 省略可能 B490B5EBF6F3CD402E515D22BCDA1598

任意: バックエンドサーバー上に設定されている Cookie です。

Cookie の長さは 1 文字から 200 文字以内で、ASCII 英字および数字のみ使用することができます。 コンマ ( , )、セミコロン ( ; )、スペースは使用できません。また、$ で始めることもできません。

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

CookieTimeout Integer 省略可能 500

任意。 Cookie のタイムアウト時間です。

値の範囲： 1 ～ 86400。 単位：秒

注 このパラメータは StickySession の値が [on]、StickySessionType の値が insert の場合に必要です。
説明 String 省略可能 リスナーの説明

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

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

任意。 HTTP から HTTPS へのリダイレクトに使用するポートです。
Gzip String 省略可能 on

任意。 Gzip 圧縮を有効にして特定のファイルタイプを圧縮するかどうかを示します。 デフォルト値： on

有効値：on | off
HealthCheckConnectPort Integer 省略可能 80

任意。 ヘルスチェック用のバックエンドサーバーのポートです。

値の範囲： 1 ～ 65535
HealthCheckDomain String 省略可能 $ _ip

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

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

任意。 ヘルスチェックが正常であるかどうかを示す HTTP ステータスコードです。 複数の HTTP ステータスコードはコンマ ( , ) で区切ります。 デフォルト値 ：http_2xx

有効値：http_2xx | http_3xx | http_4xx | http_5xx
HealthCheckInterval Integer 省略可能 5

任意。 連続した 2 回のヘルスチェックの時間間隔です。

値の範囲： 1 ～ 50。 単位：秒

HealthCheckTimeout Integer 省略可能 3

任意。 ヘルスチェックからの応答を待機する時間 (秒単位)。 バックエンド ECS インスタンスが設定した時間内に有効な応答を送信しなかった場合、ヘルスチェックは失敗します。

値の範囲： 1 ～ 300。 単位：秒

注 HealthCheckTimeout の値が HealthCheckInterval よりも小さい場合、パラメータ HealthCheckTimeout は無効であり、 タイムアウトは HealthCheckInterval の値に設定されます。
HealthCheckURI String 省略可能 /test/index.html

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

HealthyThreshold Integer 省略可能 4

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

値の範囲： 2 ～ 10
IdleTimeout Integer 省略可能 3

任意。 アイドル接続タイムアウト時間を指定します。 値の範囲：1〜60。 デフォルト値：15。 単位：秒

指定されたタイムアウト期間中にリクエストが受信されない場合、Server Load Balancer は一時的に接続を終了し、次のリクエストが受信されると接続を再開します。

ListenerForward String 省略可能 off

任意: HTTP から HTTPS へのリダイレクトを有効にするかどうかを示します。

有効値：on | off
RequestTimeout Integer 省略可能 6

任意:。 リクエストタイムアウトを指定します。 値の範囲：1〜180。 デフォルト値：10。 単位：秒

バックエンドサーバーが指定されたタイムアウト期間内に応答しない場合、SLB は待機を停止して HTTP 504 エラーコートをクライアントへ返します。

Scheduler String 省略可能 wrr

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

  • wrr (デフォルト)：重みの大きいバックエンドサーバーは、重みの小さいバックエンドサーバーより多くのリクエストを受け取ります。
  • WLC：重みが大きいサーバーほど、より多くのリクエストを受け取ります。 2 つのバックエンドサーバーの重み値が同じ場合は、接続数が少ないバックエンドサーバーがポーリングされる可能性が高くなります。
  • rr：リクエストは、バックエンドサーバーに均等かつ順次に配信されます。
StickySessionType String 省略可能 on

任意。 Cookie を処理するために使用される方式です。 有効値：

  • insert： Cookie を挿入します。

    SLB は最初のクライアントリクエスト中に Cookie に応答を追加します (つまり、HTTP / HTTPS 応答パケットに SERVERID を挿入します)。 次のリクエストには Cookie が含まれ、リスナーはリクエストを同じバックエンドサーバーに配信します。

  • server：Cookie を置き換えます。

    SLB は新しい Cookie が設定されると元の Cookie を上書きします。 次回クライアントが新しい Cookie で SLB にアクセスすると、リスナーはそのリクエストを前回記録されたバックエンドサーバーに配信します。
    注 このパラメータは StickySession の値が [on]の場合に必要です。
UnhealthyThreshold Integer 省略可能 4

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

有効値： 2 | 10
VServerGroupId String 省略可能 rsp-cige6j5e7p

任意。 VServer グループの ID です。
XForwardedFor String 省略可能 on

任意。 XForwardedFor ヘッダーフィールドを使用してクライアントの物理 ID アドレスを取得するかどうかを示します。 デフォルト値： on

有効値：on | off
XForwardedFor_SLBID String 省略可能 on

任意。 SLB インスタンス ID を取得するために SLB-ID ヘッダーフィールドを使用するかどうかを示します。

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

XForwardedFor_SLBIP String 省略可能 on

任意。 クライアントリクエストの物理 IP アドレス取得のために SLB-IP ヘッダーフィールドを使用するかどうかを示します。

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

XForwardedFor_proto String 省略可能 on

任意。 SLB インスタンスによって使用されるリスニングプロトコルを取得するために X-Forwarded-For ヘッダーフィールドを使用するかどうかを示します。

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

レスポンスパラメータ

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

リクエストの ID です。

例

リクエストの例


http(s)://[Endpoint]/? Action=CreateLoadBalancerHTTPListener
&HealthCheck=on
&ListenerPort=80 
&LoadBalancerId=lb-bp1c9vixxjh92q83tw1ae-cn-east-hangzhou-01 
&StickySession=off 
&<CommonParameters>

レスポンスの例

XML 形式 

<CreateLoadBalancerHTTPListenerResponse>
  <RequestId>1FF504CB-BFFF-4508-A51A-58A416604FC8</RequestId>
</CreateLoadBalancerHTTPListenerResponse>

JSON 形式 

{
	"RequestId":"1FF504CB-BFFF-4508-A51A-58A416604FC8"
}

エラーコード

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