すべてのプロダクト
Search

このプロダクト

    ENS:SetLoadBalancerHTTPListenerAttribute

    ドキュメントセンター

    ENS:SetLoadBalancerHTTPListenerAttribute

    最終更新日:Aug 14, 2026

    HTTP リスナーの構成を変更します。

    操作説明

    • API 呼び出し周波数: 1 秒あたり 100 回。

    • ユーザーごとの呼び出し周波数: 1 秒あたり 10 回。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    ens:SetLoadBalancerHTTPListenerAttribute

    update

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    LoadBalancerId

    string

    必須

    ロードバランシングインスタンスの ID。

    lb-5snthcyu1x10g7tywj7iu****
    ListenerPort

    integer

    必須

    属性を変更するリスナーポート。有効な値: 1～65535。

    8080
    Description

    string

    任意

    リスナー名。名前は 1～80 文字である必要があります。

    説明

    名前の先頭を http:// または https:// にすることはできません。

    Listener description
    Scheduler

    string

    任意

    スケジューリングアルゴリズム。有効な値:

    • wrr: 重みが大きいバックエンドサーバーほど高頻度でポーリングされます。

    • wlc: 各バックエンドサーバーの重みと実際のロード (接続数) に基づいてリクエストが分散されます。重みが同じ場合、接続数が少ないバックエンドサーバーほど高頻度でポーリングされます。

    • rr: リクエストはバックエンドサーバーにシーケンス順に分散されます。

    • sch: ソース IP アドレスに基づく一貫したハッシュ化。同じソース IP アドレスからのリクエストは同じバックエンドサーバーに分散されます。

    • qch: QUIC Connection ID に基づく一貫したハッシュ化。同じ QUIC Connection ID を持つリクエストは同じバックエンドサーバーに分散されます。

    • iqch: iQUIC CID の特定の 3 バイトに基づく一貫したハッシュ化。2～4 バイト目が同じリクエストは同じバックエンドサーバーに分散されます。

    列挙値:

    • rr :

      ラウンドロビン。

    • wrr :

      重み付きラウンドロビン。

    • wlc :

      重み付き最小接続数。

    wrr
    HealthCheck

    string

    任意

    ヘルスチェックを有効にするかどうかを指定します。有効な値:

    • on: 有効。

    • off: 無効。

    on
    HealthCheckDomain

    string

    任意

    ヘルスチェックに使用するドメイン名。

    説明

    このパラメーターは HealthCheck が on にセットされている場合にのみ効果があります。

    www.aliyundoc.com
    HealthCheckURI

    string

    任意

    ヘルスチェックに使用する URI。URI は 1～80 文字である必要があります。

    説明

    • URI を / のみにすることはできず、/ で始まる必要があります。

    • このパラメーターは HealthCheck が on にセットされている場合にのみ効果があります。

    /checkpreload.htm
    HealthyThreshold

    integer

    任意

    バックエンドサーバーが正常であると宣言される (ステータスが失敗から成功に変わる) までに必須の連続したヘルスチェック成功回数。有効な値: 2～10。

    説明

    このパラメーターは HealthCheck が on にセットされている場合にのみ効果があります。

    3
    UnhealthyThreshold

    integer

    任意

    バックエンドサーバーが異常であると宣言される (ステータスが成功から失敗した状態に変わる) までに必須の連続したヘルスチェック失敗回数。有効な値: 2～10。

    説明

    このパラメーターは HealthCheck が on にセットされている場合にのみ効果があります。

    3
    HealthCheckTimeout

    integer

    任意

    ヘルスチェックからの応答を待機する時間。バックエンド ECS インスタンスが指定された時間内に応答しない場合、ヘルスチェックは失敗します。

    • デフォルト値: 5 秒。

    • 有効な値: 1～300。

    • 単位: 秒。

    説明

    • このパラメーターは HealthCheck が on にセットされている場合にのみ効果があります。

    • HealthCheckTimeout の値が HealthCheckInterval の値より小さい場合、HealthCheckTimeout は無効になり、タイムアウト期間は HealthCheckInterval の値と同じになります。

    5
    HealthCheckConnectPort

    integer

    任意

    ヘルスチェックに使用するポート。有効な値: 1～65535。設定項目でこのパラメーターが設定されていない場合、バックエンドサービスポート (BackendServerPort) が使用されます。

    説明

    このパラメーターは HealthCheck が on にセットされている場合にのみ効果があります。

    65500
    HealthCheckInterval

    integer

    任意

    2 回の連続したヘルスチェックの間隔。有効な値: 1～50。単位: 秒。

    説明

    このパラメーターは HealthCheck が on にセットされている場合にのみ効果があります。

    2
    HealthCheckHttpCode

    string

    任意

    ヘルスチェックの成功を示す HTTP 状態コード。有効な値:

    • http_2xx (デフォルト)。

    • http_3xx。

    • http_4xx。

    • http_5xx。

    説明

    このパラメーターは HealthCheck が on にセットされている場合にのみ効果があります。

    http_2xx
    IdleTimeout

    integer

    任意

    アイドル接続タイムアウト期間。デフォルト値: 15 秒。有効な値: 1～60。単位: 秒。

    説明

    タイムアウト時間内にアクセスリクエストを受信しない場合、ロードバランシングインスタンスは現在の接続を一時的に切断し、次のリクエストが到着したときに新しい接続を再確立します。

    15
    RequestTimeout

    integer

    任意

    リクエストタイムアウト期間。デフォルト値: 60 秒。有効な値: 1～180。単位: 秒。

    説明

    タイムアウト時間内にバックエンドサーバーから応答を受信しない場合、ロードバランシングインスタンスは待機を停止し、クライアントに HTTP 504 エラーコードを返します。

    60
    HealthCheckMethod

    string

    任意

    HTTP リスナーのヘルスチェックメソッド。有効な値:

    • head。

    • get。

    説明

    このパラメーターは HealthCheck が on にセットされている場合にのみ効果があります。

    列挙値:

    • head :

      HEAD メソッド。

    • get :

      GET メソッド。

    head
    XForwardedFor

    string

    任意

    X-Forwarded-For ヘッダーを使用してクライアントの送信元 IP アドレスを取得するかどうかを指定します。有効な値:

    • on (デフォルト): 有効。

    • off: 無効。

    列挙値:

    • off :

      無効。

    • on :

      有効。

    on

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ。

    RequestId

    string

    リクエスト ID。

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 ens.interface.error An error occurred while call the API.
    400 Invalid%s The specified parameter %s is invalid.
    400 Missing%s You must specify the parameter %s.
    400 LoadBalancerNotFound The input parameter loadBalancerId that is not found.
    400 IncorrectInstanceStatus The current status of the resource does not support this operation.
    400 ListenerNotFound The input parameter listener that is not found.
    400 IncorrectListenerStatus The current status of the resource does not support this operation.
    400 NoPermission Permission denied.
    400 InvalidParameter.%s The specified field %s invalid. Please check it again.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。