すべてのプロダクト
Search

このプロダクト

    ENS:DescribeLoadBalancerHTTPListenerAttribute

    ドキュメントセンター

    ENS:DescribeLoadBalancerHTTPListenerAttribute

    最終更新日:Mar 20, 2026

    HTTP リスナーの構成をクエリします。

    操作説明

    • アカウントごとに、この操作を 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:DescribeLoadBalancerHTTPListenerAttribute

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ListenerPort

    integer

    必須

    クエリ対象のリスナーポート。有効値：1 ～ 65535。

    80
    LoadBalancerId

    string

    必須

    ELB インスタンスの ID。

    lb-5snthcyu1x10g7tywj7iu****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンススキーマ

    RequestId

    string

    リクエスト ID。

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    ListenerPort

    integer

    リスナーポート。

    80
    Status

    string

    リスナーのステータス。有効値：

    • Running

    • Stopped

    • Starting

    • Configuring

    • Stopping

    Running
    Bandwidth

    integer

    Edge Load Balancer (ELB) インスタンスのピーク帯域幅。デフォルト値は -1 で、帯域幅が制限されていないことを示します。

    -1
    Scheduler

    string

    ルーティングアルゴリズム。有効値：

    • wrr：重みの高いバックエンドサーバーほど、多くのリクエストを受け取ります。

    • wlc：各バックエンドサーバーの重みと負荷に基づいてリクエストを分散します。負荷とは、バックエンドサーバーへの接続数を指します。2 つのバックエンドサーバーの重みが同じ場合、接続数が少ないサーバーほど多くのリクエストを受け取ります。

    • rr：リクエストをバックエンドサーバーに順番に分散します。

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

    • qch：QUIC 接続 ID に基づく一貫したハッシュ。同じ QUIC 接続 ID を含むリクエストは、同じバックエンドサーバーに分散されます。

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

    wrr
    HealthCheck

    string

    ヘルスチェック機能が有効かどうかを示します。有効値：

    • on

    • off

    on
    HealthyThreshold

    integer

    ヘルスチェックに失敗してアクセス不能になったバックエンドサーバーが正常かつアクセス可能と判断されるまでに必要な、連続するヘルスチェック成功回数。有効値：2 ～ 10。

    説明

    このパラメーターは、HealthCheck を on に設定した場合にのみ返されます。

    3
    UnhealthyThreshold

    integer

    ヘルスチェックに成功してアクセス可能なバックエンドサーバーが異常かつアクセス不能と判断されるまでに必要な、連続するヘルスチェック失敗回数。有効値：2 ～ 10。

    説明

    このパラメーターは、HealthCheck を on に設定した場合にのみ返されます。

    3
    HealthCheckTimeout

    integer

    ヘルスチェック応答のタイムアウト期間。指定されたタイムアウト期間内にバックエンドサーバーが応答しない場合、そのサーバーはヘルスチェックに失敗します。

    • デフォルト値：5

    • 有効値：1 ～ 300

    • 単位：秒

    説明

    • このパラメーターは、HealthCheck パラメーターが on に設定されている場合にのみ有効です。

    • HealthCheckTimeout の値が HealthCheckInterval の値より小さい場合、HealthCheckTimeout で指定されたタイムアウト期間は無効となり、HealthCheckInterval の値がタイムアウト期間として使用されます。

    10
    HealthCheckConnectPort

    integer

    ヘルスチェックに使用するポート。有効値：1 ～ 65535。このパラメーターを空のままにすると、BackendServerPort で指定されたポートがヘルスチェックに使用されます。

    説明

    このパラメーターは、HealthCheck を on に設定した場合にのみ返されます。

    5000
    HealthCheckInterval

    integer

    ヘルスチェックの実行間隔。有効値：1 ～ 50。単位：秒。

    説明

    このパラメーターは、HealthCheck を on に設定した場合にのみ返されます。

    5
    Description

    string

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

    説明

    値は http:// または https:// で始まってはいけません。

    abc
    ListenerForward

    string

    HTTP から HTTPS への自動転送が有効かどうかを示します。有効値：

    • on：HTTP から HTTPS への自動転送が有効になります。

    • off（デフォルト）

    off
    ForwardPort

    integer

    HTTP リクエストを HTTPS にリダイレクトするために使用するリスナーポート。

    10002
    RequestTimeout

    integer

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

    説明

    指定されたタイムアウト期間内にバックエンドサーバーから応答がない場合、ELB はクライアントに HTTP 504 エラーコードを返します。

    60
    IdleTimeout

    integer

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

    説明

    指定されたタイムアウト期間内にリクエストが受信されない場合、ELB は接続を閉じます。次のリクエストを受信した際に、ELB は新しい接続を確立します。

    15
    HealthCheckHttpCode

    string

    ヘルスチェックが成功とみなされる HTTP ステータスコード。有効値：

    • http_2xx（デフォルト）

    • http_3xx。

    • http_4xx

    • http_5xx

    説明

    このパラメーターは、HealthCheck を on に設定した場合にのみ返されます。

    http_2xx
    HealthCheckDomain

    string

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

    説明

    このパラメーターは、HealthCheck を on に設定した場合にのみ返されます。

    www.example.com
    HealthCheckURI

    string

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

    説明

    • URL はスラッシュ (/) で始まる必要がありますが、スラッシュ (/) のみを含んではいけません。

    • このパラメーターは、HealthCheck パラメーターが on に設定されている場合にのみ有効です。

    /checkpreload.htm
    ServerCertificateId

    string

    サーバー証明書の ID。

    6027667
    HealthCheckMethod

    string

    HTTP ヘルスチェックで使用されるヘルスチェックメソッド。有効値：

    • head：ページのヘッダーをリクエストします。

    • get：ページの指定部分をリクエストし、エンティティ本文を返します。

    説明

    このパラメーターは、HealthCheck を on に設定した場合にのみ返されます。

    head
    XForwardedFor

    string

    X-Forwarded-For ヘッダーを使用してクライアントの実際の IP アドレスを取得するかどうかを示します。有効値：

    • on（デフォルト）

    • off

    on

    BackendServerPort

    integer

    ELB インスタンスのバックエンドサーバーが使用するポート。有効値：1 ～ 65535。

    8080

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "ListenerPort": 80,
  "Status": "Running",
  "Bandwidth": -1,
  "Scheduler": "wrr",
  "HealthCheck": "on",
  "HealthyThreshold": 3,
  "UnhealthyThreshold": 3,
  "HealthCheckTimeout": 10,
  "HealthCheckConnectPort": 5000,
  "HealthCheckInterval": 5,
  "Description": "abc",
  "ListenerForward": "off",
  "ForwardPort": 10002,
  "RequestTimeout": 60,
  "IdleTimeout": 15,
  "HealthCheckHttpCode": "http_2xx",
  "HealthCheckDomain": "www.example.com",
  "HealthCheckURI": "/checkpreload.htm",
  "ServerCertificateId": "6027667",
  "HealthCheckMethod": "head",
  "XForwardedFor": "on\n",
  "BackendServerPort": 8080
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 LoadBalancerNotFound The input parameter loadBalancerId that is not found.
    400 ListenerNotFound Listener is not found.
    400 ens.interface.error Failed to call API.
    400 NoPermission Permission denied.
    400 InvalidParameter.%s The specified field %s invalid. Please check it again.

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

    変更履歴

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