HTTPS リスナーの設定情報を変更します。

デバッグ

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

リクエストパラメータ

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

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

ListenerPort Integer 省略可能 80

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

値の範囲: 1 ~ 65535

LoadBalancerId String 必須 139a00604ad-cn-east-hangzhou-01

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

RegionId String 必須 cn-hangzhou

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

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

AclId String 省略可能 56565

任意。 リスナーに関連づいているアクセス制御リストの ID です。

このパラメータは AclStatus パラメータの値を [on] に設定している場合に必要です。

AclStatus String 省略可能 off

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

有効値:on | off

AclType String 省略可能 white

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

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

    ホワイトリストを有効にすると、サービスにリスクが発生します。 ホワイトリストの設定後、リスト内の IP アドレスのみがリスナーにアクセスできます。 リストに IP アドレスを追加せずにホワイトリストを有効にした場合、リクエストは転送されません。

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

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

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

帯域幅 Integer 省略可能 -1

任意。 リスナーのピーク帯域幅。 有効な値: -1 | 0 1〜5120

  • -1:ピーク帯域幅は制限されません。
  • 1 ~ 5120:リスナーのピーク帯域幅です。 全リスナーの合計ピーク帯域幅は、インスタンスのピーク帯域幅を超えることはできません。
CACertificateId String 省略可能 139a00604ad-cn-east-hangzhou-01

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

CA 証明書とサーバー証明書の両方がアップロードされると、相互認証が確立されます。 サーバー証明書のみがアップロードされている場合は、一方向認証が確立されています。

Cookie String 省略可能 B490B5EBF6F3CD402E515D22BCDA1598

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

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

この Cookie は StickySession の値が [on] で、 StickySessionType の値が server の時に必要です。

CookieTimeout Integer 省略可能 500

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

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

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

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

EnableHttp2 String 省略可能 off

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

有効な値:on | off

Gzip String 省略可能 on

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

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

HealthCheck String 省略可能 on

任意。 ヘルスチェック機能を有効にするかどうかを示します。

有効値:on | off

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_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 省略可能 23

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

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

RequestTimeout Integer 省略可能 223

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

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

Scheduler String 省略可能 wrr

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

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

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

StickySession String 省略可能 on

任意。 セッション維持を有効にするかしないかを選択します。 有効値:on | off

StickySessionType String 省略可能 on

任意。 Cookie 処理するために使用する方法。 有効値:

  • insert:Cookie の挿入

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

  • server:Cookie の書き換え

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

このパラメータは StickySession の値が [on] の場合に必要です。
TLSCipherPolicy String 省略可能 tls_cipher_policy_1_2

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

現在、以下の 3 つのスケーリングルールを定義できます。

  • 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, and 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, and DES-CBC3-SHA.
  • tls_cipher_policy_1_2_strict
    • サポート対象おn 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, and ECDHE-RSA-AES256-SHA.
UnhealthyThreshold Integer 省略可能 4

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

値の範囲: 2 ~ 10

VServerGroup String 省略可能 on

任意。 VServer グループを使用するかどうかを示します。 有効値: on | off

VServerGroupId String 省略可能 rsp-cige6j5e7p

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

XForwardedFor String 省略可能 on

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

有効値:on | off

XForwardedFor_SLBID String 省略可能 on

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

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

XForwardedFor_SLBIP String 省略可能 on

任意。 SLB-IP ヘッダーフィールドを使用してクライアントリクエストの実際の 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=SetLoadBalancerHTTPSListenerAttribute
&ListenerPort=80 
&LoadBalancerId=139a00604ad-cn-east-hangzhou-01 
&<CommonParameters>

レスポンスの例

XML 形式

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

JSON 形式

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

エラーコード

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