edit-icon download-icon

SetLoadBalancerHTTPListenerAttribute

最終更新日: Aug 28, 2017

説明

HTTP リスナーを設定します。

リクエストパラメーター

名前 必須かどうか 説明
Action String はい システムで指定するオペレーティングインターフェイス名。
値: SetLoadBalancerHTTPListenerAttribute
RegionId String はい リージョンの ID
LoadBalancerId String はい Server Load Balancer インスタンスの一意の ID。
ListenerPort Integer はい Server Load Balancer インスタンスのフロントエンドで使用されるポート。
値: 1 ~ 65535
Bandwidth Integer はい リスナーの帯域幅ピーク。
値: -1 / 1 ~ 1000 Mbps
固定帯域幅ごとに課金されるパブリックネットワークインスタンス。
消費したトラフィックに対して課金されるパブリックネットワークインスタンスについては、リスナーの Bandwidth 値を -1 に設定できます。これは、帯域幅ピークが無制限であることを示します
XForwardedFor String いいえ 訪問者の実際の IP アドレスを X-Forwarde d-For を使って取得するかどうか。
値: on / off
デフォルト: なし
パラメーターが指定されない場合、この設定項目はこの呼び出しで変更されず、以前の設定が維持されることを示します
Scheduler String いいえ スケジューリングアルゴリズム。
値: wrr / wlc
デフォルト: wrr
StickySession String はい セッション維持を有効にするかどうか。
値: on / off
StickySessionType String 適宜 クッキーの処理モード。
StickySession が on の場合、パラメーターは必須になり、StickySession が off の場合、パラメーターは無視されます。
値: insert / server
insert に設定されると、Server Load Balancer から挿入されることを意味します。server に設定されると、Server Load Balancer はバックエンドサーバーから習得することを意味します。
CookieTimeout Integer 適宜 クッキーのタイムアウト。
このパラメーターは、StickySession が on で StickySessionType が insert の場合には必須です。それ以外の場合、パラメーターは無視されます。
値: 1 ~ 86400 (秒)
Cookie String 適宜 サーバーに設定されたクッキー。
StickySession が on で、StickySessionType が server の場合にのみ必須になり、それ以外の場合、パラメーターは無視されます。
値: RFC 2965 の行の文字列。長さは 1 ~ 200。
ASCII コード、英文字、数字などの文字のみが含まれます。コンマ、セミコロン、スペースを含むことはできず、また $ を先頭にすることはできません。
HealthCheck String はい ヘルスチェックを有効にするかどうか。
値: on / off
HealthCheckDomain String いいえ ヘルスチェックに使用されるドメイン名。
HealthCheck が on の場合、パラメーターは必須になり、HealthCheck が off の場合、パラメーターは無視されます。
値: $_ip / カスタム文字列
カスタム文字列のルール: 長さは 1 ~ 80 文字に制限され、文字、数字、’-‘ および ‘.’ のみが使用できます。
パラメーターがユーザーによって $_ip に設定されると、Server Load Balancer は各バックエンドサーバーのプライベートネットワーク IP アドレスをヘルスチェックのドメインとして使用します。
HealthCheckURI String 適宜 ヘルスチェックに使用される URI。
HealthCheck が on の場合、パラメーターは必須になり、HealthCheck が off の場合、パラメーターは無視されます。
値: 長さは 1 ~ 80 文字に制限され、先頭は / である必要があります。 文字、数字、’-‘、’/‘、’.’、’%’、’?’、’#’ および ‘&’ のみが使用できます。
HealthCheckConnectPort Integer 適宜 ヘルスチェックに使用されるポート。
HealthCheck が on の場合、パラメーターは必須になり、HealthCheck が off の場合、パラメーターは無視されます。
値: 1 ~ 65535 または ‘-520’。
パラメーターが -520 に設定される場合、バックエンドサーバーポート (Backen dServerPort) が使用されることを意味します。
HealthyThreshold Integer 適宜 ヘルスチェックの結果を決定するしきい値は success です。つまり、ヘルスチェックに連続して何回成功すると、バックエンドサーバーのヘルスチェックの結果が fail から success に変わるかを示します。
HealthCheck が on の場合、パラメーターは必須になり、HealthCheck が off の場合、パラメーターは無視されます。
値: 1 ~ 10
UnhealthyThreshold Integer 適宜 ヘルスチェックの結果を決定するしきい値は fail です。つまり、ヘルスチェックに連続して何回失敗すると、バックエンドサーバーのヘルスチェックの結果が success から fail に変わるかを示します。
HealthCheck が on の場合、パラメーターは必須になり、HealthCheck が off の場合、パラメーターは無視されます。
値: 1 ~ 10
HealthCheckTimeout Integer 適宜 各ヘルスチェックの応答の最大タイムアウト。
HealthCheck が on の場合、パラメーターは必須になり、HealthCheck が off の場合、パラメーターは無視されます。
値: 1 ~ 50 (秒)
注意: HealthCHeckTimeout<HealthCheckInterval である場合、HCTimeout は無効であり、タイムアウトは HealthCheckInterval です。
HealthCheckInterval Integer 適宜 ヘルスチェックの間隔。
HealthCheck が on の場合、パラメーターは必須になり、HealthCheck が off の場合、パラメーターは無視されます
値: 1 ~ 5 (秒)
HealthCheckHttpCode String 適宜 定期ヘルスチェックの HTTP ステータスコード。複数のコードは “,” で区切ります。
HealthCheck が on の場合、パラメーターは必須になり、HealthCheck が off の場合、パラメーターは無視されます。
値: http_2xx / http_3xx / http_4xx / http_5xx
デフォルト: http_2xx
VServerGroup String いいえ Vserver グループを使用するかどうか。値: on/off.
デフォルト: off
VServerGroupId String いいえ Vserver グループの ID
Gzip String いいえ Gzip が有効かどうか。特定のタイプに Gzip を使用する。値: on/off
デフォルト: on
XForwardedFor_SLBIP String いいえ XForwardedFor_SLBIP のヘッダーを開くかどうか。値: on/off
デフォルト: off
XForwardedFor_SLBID String いいえ XForwardedFor_SLBID のヘッダーを開くかどうか。値: on/off
デフォルト: off
XForwardedFor_proto String いいえ XForwardedFor_proto のヘッダーを開くかどうか。値: on/off
デフォルト: off

リターンパラメーター

リターンパラメーターはすべて共通です。詳細については、「共通のリターンパラメーター」を参照してください。

リクエストの例

  1. https://slb.aliyuncs.com/
  2. &Action=SetLoadBalancerHTTPListenerAttribute
  3. &LoadBalancerId=139a00604ad-cn-east-hangzhou-01
  4. &ListenerPort=-520
  5. &Bandwidth=-1
  6. &<common request parameter>

戻り値の例

  • XML 形式
    1. <?xml version="1.0" encoding="UTF-8"?>
    2. <SetLoadBalancerHTTPListenerAttributeResponse>
    3. <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
    4. </SetLoadBalancerHTTPListenerAttributeResponse>
  • JSON 形式
    1. { "RequestId":" CEF72CEB-54B6-4AE8-B225-F876FF7BA984" }