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

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

デバッグ

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

リクエストパラメータ

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

この操作の名前です。 値:CreateLoadBalancerHTTPSListener

Bandwidth Integer 省略可能 -1

リスナー有効値のピーク帯域幅:-1 | 1〜5120 単位:Mbit /秒

  • -1 :値 -1 はトラフィックによって課金されるインターネットインスタンスの帯域幅が制限されていないことを示します。
  • 1〜510 :帯域幅で課金されるインターネットインスタンスの場合、1 リスナーにつき 1 つのピーク帯域幅を設定できます。 全リスナーの合計ピーク帯域幅が、インスタンスのピーク帯域幅を超えることはできません。 詳。
HealthCheck String 必須 on

ヘルスチェック機能を有効にするかどうかを示します。 有効値:on | off

ListenerPort Integer 省略可能 80

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

LoadBalancerId String 必須 lb-bp1094dp5i6earr9g6d11l

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

RegionId String 必須 cn-hangzhou

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

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

ServerCertificateId String 必須 idkp-123-cn-test-01

サーバー証明書の ID です。

StickySession String 必須 on

セッション持続性を有効にするかしないかを選択します。

有効値:on | off

AclId String 省略可能 123

任意。 リスナーと関連づけられたアクセス制御リストの ID です。

このパラメータは 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

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

CACertificateId String 省略可能 139a00604ad-cn-east-hangzhou-01

任意。 CA 証明書の ID です。

CA 証明書とサーバー証明書の両方がアップロードされると、双方向認証が確立されます。

サーバー証明書のみをアップロードすると、一方向の認証が確立されます。

Cookie String 省略可能 B490B5EBF6F3CD402E515D22BCDA1598

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

名前の長さは 1 ~ 200 文字です。 ASCII の英字と数字だけ使用することができます。 コンマ ( , )、セミコロン ( ; )、またはスペースは使用できません。 ドル記号 ($) で始めることはできません。

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

CookieTimeout Integer 省略可能 500

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

値の範囲: 1 ~ 86400。 単位:秒

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

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

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

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

EnableHttp2 String 省略可能 off

任意。 HTTP/2 機能を有効にするかどうかを示します。

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

Gzip String 省略可能 on

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

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

HealthCheckConnectPort Integer 省略可能 8080

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

値の範囲: 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 省略可能 12

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

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

RequestTimeout Integer 省略可能 23

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

指定されたタイムアウト期間中にバックエンドサーバーから応答がない場合、Server Load Balancer は待機を停止し、HTTP 504 エラーをクライアントに送信します。

Scheduler String 省略可能 wrr

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

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

任意。 Cookie 処理のために使用される方式です。 StickySession の値が on に設定されている場合、このパラメータが必要です。

有効な値:insert | server

  • insert:Cookie を挿入します。

    SLB はバックエンドサーバーからの最初の応答にクッキーを追加します。 具体的には、HTTP / HTTPS 応答パケットに SERVERID を挿入します。 次のリクエストには Cookie が含まれ、リスナーはリクエストを同じバックエンドサーバーに配信します。

  • server:Cookier を書き換えます。

    新しい Cookie が設定されると、SLB は元の Cookie を上書きします。 次回クライアントが新しい Cookie で SLB にアクセスすると、リスナーはそのリクエストを前回記録されたバックエンドサーバーに配信します。

TLSCipherPolicy String 省略可能 tls_cipher_policy_1_1

パフォーマンス専有型のみに TLSCipherPolicy パラメータを指定することができます。 各セキュリティポリシーには、HTTPS および対応する暗号スイートにより選択可能な TLS プロトコルバージョンが含まれています。

現在、次の4つのセキュリティポリシーがサポートされています。 違いの詳細については、TLSセキュリティポリシーの違いの紹介を参照してください。

  • tls_cipher_policy_1_0:
    • 対応されている TLS バージョン:TLSv1.0、TLSv1.1、TLSv1.2.
    • サポート対象の暗号化アルゴリズムスイート:ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、 ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、 AES256-GCM-SHA384、AES128-SHA256、 AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA, AES256-SHA、および DES-CBC3-SHA。
  • tls_cipher_policy_1_1:
    • 対応している TLS バージョン:TLSv1.1, TLSv1.2.
    • サポート対象の暗号化アルゴリズムスイート: ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA および DES-CBC3-SHA。
  • tls_cipher_policy_1_2
    • 対応している TLS バージョン:TLSv1.2.
    • サポート対象の暗号化アルゴリズムスイート: ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA および DES-CBC3-SHA。
  • tls_cipher_policy_1_2_strict
    • 対応している TLS バージョン:TLSv1.2.
    • 対応されている暗号化アルゴリズムスイート:ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, ECDHE-RSA-AES128-SHA, ECDHE-RSA-AES256-SHA.
UnhealthyThreshold Integer 省略可能 4

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

Value range: 2 to 10

VServerGroupId String 省略可能 rsp-cige6j5e7p

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

XForwardedFor String 省略可能 on

任意。 X-Forwarded-For を使用してクライアントリクエストの物理 IP アドレスを取得するかどうかを示します。

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

XForwardedFor_SLBID String 省略可能 on

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

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

XForwardedFor_SLBIP String 省略可能 on

任意。 SLB-IP ヘッダフィールドを使用してビジターの物理 IP アドレスを取得するかどうかを示します。

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

XForwardedFor_proto String 省略可能 on

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

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

レスポンスパラメータ

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

リクエストの ID です。

リクエストの例


http(s)://[Endpoint]/? &Action=CreateLoadBalancerHTTPSListener
&Bandwidth=-1 
&HealthCheck=on 
&ListenerPort=80 
&LoadBalancerId=lb-bp1o94dp5i6earr9g6d1l 
&ServerCertificateId=idkp-123-cn-test-01 
&StickySession=on 
&<CommonParameters>

レスポンスの例

XML 形式

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

JSON 形式

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

エラーコード

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