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

デバッグ

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

リクエストパラメータ

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

この操作の名前です。 値：SetLoadBalancerHTTPListenerAttribute
ListenerPort Integer 必須 80

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

値の範囲：1 ～ 65535
LoadBalancerId String 必須 lb-bp1qjwo61pqz3ahltv0mw

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

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

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

AclId String 省略可能 123

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

このパラメータは 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 | 1〜5120 。 単位：Mbit/秒

  • -1：トラフィックによって請求されるインターネット SLB インスタンスのピーク帯域幅を -1 に設定できます。 その場合、ピーク帯域幅は制限されません。
Cookie String 省略可能 B490B5EBF6F3CD402E515D22BCDA1598

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

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

この値は StickySession の値が [on] で StickySessionType の値が server の場合に必要です。

CookieTimeout Integer 省略可能 500

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

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

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

説明 String 省略可能 test

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

Gzip String 省略可能 on

任意。 Gzip 圧縮を有効にするかどうかを示します。
HealthCheck String 省略可能 on

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

有効値：on | off。

HealthCheckConnectPort Integer 省略可能 8080

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

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

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

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

任意。 ヘルスチェックが正常であるかどうかを示す HTTPS ステータスコードです。 コンマ ( , ) を使って、複数の 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 省略可能 12

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

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

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

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

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

  • wrr ：重みの大きいバックエンドサーバーはポーリングされる可能性が高くなります。

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

    2 つのバックエンドサーバーの重み値が同じ場合は、接続数が少ないバックエンドサーバーの方がポーリングされる可能性が高くなります。

  • rr：リクエストは、バックエンドサーバーに均等かつ順次に配信されます。
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] の時に必要です。
UnhealthyThreshold Integer 省略可能 4

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

値の範囲： 2 ～ 10
VServerGroup String 省略可能 on

任意。 VServer グループを使用するかどうかを示します。

有効な値： on | off
VServerGroupI String 省略可能 rsp-cige6j5e7p

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

任意。 X-Forwarded-For を介したクライアント要求の実際の IP アドレスを取得するかどうかを示します。

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

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

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

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

このパラメータを設定しない場合、デフォルト値が使用されます。

レスポンスパラメータ

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

リクエストの ID です。

例

リクエストの例


http(s)://[Endpoint]/? Action=SetLoadBalancerHTTPListenerAttribute
&ListenerPort=80 
&LoadBalancerId=lb-bp1qjwo61pqz3ahltv0mw 
&<CommonParameters>

レスポンスの例

XML 形式 

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

JSON 形式 

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

エラーコード

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