すべてのプロダクト
Search

このプロダクト

    Server Load Balancer:GetListenerHealthStatus

    ドキュメントセンター

    Server Load Balancer:GetListenerHealthStatus

    最終更新日:May 25, 2026

    リスナーおよびその転送ルールのヘルスチェックステータスを取得します。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    alb:GetListenerHealthStatus

    get

    *LoadBalancer

    acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ListenerId

    string

    必須

    リスナーの ID。

    lsn-o4u54y73wq7b******
    IncludeRule

    boolean

    任意

    転送ルールのヘルスチェック結果を含めるかどうか。

    • true

    • false (デフォルト)

    true
    NextToken

    string

    任意

    結果の次ページを取得するためのトークン。

    • 最初のリクエストでは、このパラメーターを指定する必要はありません。

    • 後続のリクエストでは、前の応答で返された NextToken の値を設定します。

    FFmyTO70tTpLG6I3FmYAXGKPd****
    MaxResults

    integer

    任意

    各ページで返すエントリの数。範囲： 1～30。デフォルト： 20。

    20

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    リスナーと、それに関連する転送ルールのヘルスチェックステータスです。

    ListenerHealthStatus

    array<object>

    リスナーに関連するサーバーグループのヘルスチェックステータスのリストです。

    array<object>

    リスナーに関連付けられている単一のサーバーグループのヘルスチェックステータスです。

    ListenerId

    string

    リスナーの ID です。

    lsn-o4u54y73wq7b******
    ListenerPort

    integer

    リスナーが使用するポートです。

    80
    ListenerProtocol

    string

    リスナーが使用するプロトコルです。

    http
    ServerGroupInfos

    array<object>

    サーバーグループに関する情報です。

    array<object>

    関連するサーバーグループの詳細です。

    HealthCheckEnabled

    string

    ヘルスチェックが有効かどうかを示します。値が on の場合、ヘルスチェックは有効です。

    on
    NonNormalServers

    array<object>

    異常なバックエンドサーバーのリストです。

    array<object>

    異常なバックエンドサーバーの詳細です。

    Port

    integer

    バックエンドサーバーのポートです。

    90
    Reason

    object

    バックエンドサーバーが異常となった理由です。

    ActualResponse

    string

    バックエンドサーバーが返した実際の応答コードです。例： 302。

    説明

    ReasonCode が RESPONSE_MISMATCH の場合にのみ、このパラメーターが返されます。

    302
    ExpectedResponse

    string

    バックエンドサーバーに期待される応答コードです。

    複数の値を指定できます。カンマ (,) で区切ってください。

    説明

    ReasonCode が RESPONSE_MISMATCH の場合にのみ、このパラメーターが返されます。

    HTTP_2xx
    ReasonCode

    string

    バックエンドサーバーの Status が異常である理由の詳細です。 このパラメーターは、HTTP および HTTPS リスナーと転送ルールの場合にのみ返されます。

    • CONNECT_TIMEOUT ：ヘルスチェック中にバックエンドサーバーへの接続がタイムアウトしました。

    • CONNECT_FAILED ：ヘルスチェック中にバックエンドサーバーへの接続に失敗しました。

    • RECV_RESPONSE_FAILED ：ヘルスチェック中にバックエンドサーバーから応答を受信できませんでした。

    • RECV_RESPONSE_TIMEOUT ：バックエンドサーバーからの応答を待機中にヘルスチェックがタイムアウトしました。

    • SEND_REQUEST_FAILED ：バックエンドサーバーへのヘルスチェックリクエストの送信に失敗しました。

    • SEND_REQUEST_TIMEOUT ：バックエンドサーバーへのリクエスト送信中にヘルスチェックがタイムアウトしました。

    • RESPONSE_FORMAT_ERROR ：バックエンドサーバーからのヘルスチェック応答が不正な形式でした。

    • RESPONSE_MISMATCH ：バックエンドサーバーからのヘルスチェック応答コードが、期待されるコードと一致しませんでした。

    RESPONSE_MISMATCH
    ServerId

    string

    バックエンドサーバーの ID です。

    i-uf62h8v******
    ServerIp

    string

    バックエンドサーバーの IP アドレスです。

    192.168.8.10
    Status

    string

    ヘルスチェックのステータスです。有効な値：

    • Initial ：サーバーは初期化中です。ヘルスチェックは設定されていますが、まだ最初の結果を受信していません。

    • Unhealthy ：サーバーは複数回連続してヘルスチェックに失敗しました。

    • Unused ：サーバーは使用されていません。重みが 0 に設定されている場合、またはクロスゾーン負荷分散が無効で、サーバーが ALB インスタンスとは異なるアベイラビリティーゾーンにある場合に発生することがあります。

    • Unavailable ：このサーバーのヘルスチェックは無効です。

    Initial
    ServerGroupId

    string

    サーバーグループの ID です。

    sgp-8ilqs4axp6******
    ActionType

    string

    サーバーグループのアクションタイプです。有効な値：

    • ForwardGroup ：サーバーグループにトラフィックを転送します。

    • TrafficMirror ：サーバーグループにトラフィックをミラーリングします。

    TrafficMirror
    RequestId

    string

    リクエスト ID です。

    CEF72CEB-54B6-4AE8-B225-F876F******
    RuleHealthStatus

    array<object>

    転送ルールのヘルスチェックステータスのリストです。

    array<object>

    単一の転送ルールのヘルスチェックステータスです。

    RuleId

    string

    転送ルールの ID です。

    rule-hp34s2h0xx1ht4nwo****
    ServerGroupInfos

    array<object>

    関連するサーバーグループのリストです。

    array<object>

    関連するサーバーグループの詳細です。

    HealthCheckEnabled

    string

    ヘルスチェックが有効かどうかを示します。値が on の場合、ヘルスチェックは有効です。

    on
    NonNormalServers

    array<object>

    異常なバックエンドサーバーのリストです。

    array<object>

    異常なバックエンドサーバーの詳細です。

    Port

    integer

    バックエンドサーバーのポートです。

    90
    Reason

    object

    バックエンドサーバーが異常となった理由です。

    ActualResponse

    string

    バックエンドサーバーが返した実際の応答コードです。例： 302。

    説明

    ReasonCode が RESPONSE_MISMATCH の場合にのみ、このパラメーターが返されます。

    302
    ExpectedResponse

    string

    バックエンドサーバーに期待される応答コードです。

    複数の値を指定できます。カンマ (,) で区切ってください。

    説明

    ReasonCode が RESPONSE_MISMATCH の場合にのみ、このパラメーターが返されます。

    HTTP_2xx
    ReasonCode

    string

    バックエンドサーバーの Status が異常である理由の詳細です。 このパラメーターは、HTTP および HTTPS リスナーと転送ルールの場合にのみ返されます。

    • CONNECT_TIMEOUT ：ヘルスチェック中にバックエンドサーバーへの接続がタイムアウトしました。

    • CONNECT_FAILED ：ヘルスチェック中にバックエンドサーバーへの接続に失敗しました。

    • RECV_RESPONSE_FAILED ：ヘルスチェック中にバックエンドサーバーから応答を受信できませんでした。

    • RECV_RESPONSE_TIMEOUT ：バックエンドサーバーからの応答を待機中にヘルスチェックがタイムアウトしました。

    • SEND_REQUEST_FAILED ：バックエンドサーバーへのヘルスチェックリクエストの送信に失敗しました。

    • SEND_REQUEST_TIMEOUT ：バックエンドサーバーへのリクエスト送信中にヘルスチェックがタイムアウトしました。

    • RESPONSE_FORMAT_ERROR ：バックエンドサーバーからのヘルスチェック応答が不正な形式でした。

    • RESPONSE_MISMATCH ：バックエンドサーバーからのヘルスチェック応答コードが、期待されるコードと一致しませんでした。

    RESPONSE_MISMATCH
    ServerId

    string

    バックエンドサーバーの ID です。

    i-uf62h8v******
    ServerIp

    string

    バックエンドサーバーの IP アドレスです。

    192.168.2.11
    Status

    string

    ヘルスチェックのステータスです。有効な値：

    • Initial ：サーバーは初期化中です。ヘルスチェックは設定されていますが、まだ最初の結果を受信していません。

    • Unhealthy ：サーバーは複数回連続してヘルスチェックに失敗しました。

    • Unused ：サーバーは使用されていません。重みが 0 に設定されている場合、またはクロスゾーン負荷分散が無効で、サーバーが ALB インスタンスとは異なるアベイラビリティーゾーンにある場合に発生することがあります。

    • Unavailable ：このサーバーのヘルスチェックは無効です。

    Initial
    ServerGroupId

    string

    サーバーグループの ID です。

    sgp-8ilqs4axp6******
    ActionType

    string

    サーバーグループのアクションタイプです。有効な値：

    TrafficMirror
    NextToken

    string

    結果の次のページを取得するために、次のリクエストで使用するページネーショントークンです。

    • このパラメーターが空の場合、すべての結果が返されています。

    • 値が返された場合は、次のページの結果を取得するために、次のリクエストでこの値を渡してください。

    FFmyTO70tTpLG6I3FmYAXGKPd****

    例

    成功レスポンス

    JSONJSON

    {
  "ListenerHealthStatus": [
    {
      "ListenerId": "lsn-o4u54y73wq7b******",
      "ListenerPort": 80,
      "ListenerProtocol": "http",
      "ServerGroupInfos": [
        {
          "HealthCheckEnabled": "on",
          "NonNormalServers": [
            {
              "Port": 90,
              "Reason": {
                "ActualResponse": "302",
                "ExpectedResponse": "HTTP_2xx",
                "ReasonCode": "RESPONSE_MISMATCH"
              },
              "ServerId": "i-uf62h8v******",
              "ServerIp": "192.168.8.10",
              "Status": "Initial"
            }
          ],
          "ServerGroupId": "sgp-8ilqs4axp6******",
          "ActionType": "TrafficMirror"
        }
      ]
    }
  ],
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876F******",
  "RuleHealthStatus": [
    {
      "RuleId": "rule-hp34s2h0xx1ht4nwo****",
      "ServerGroupInfos": [
        {
          "HealthCheckEnabled": "on",
          "NonNormalServers": [
            {
              "Port": 90,
              "Reason": {
                "ActualResponse": "302",
                "ExpectedResponse": "HTTP_2xx",
                "ReasonCode": "RESPONSE_MISMATCH"
              },
              "ServerId": "i-uf62h8v******",
              "ServerIp": "192.168.2.11",
              "Status": "Initial"
            }
          ],
          "ServerGroupId": "sgp-8ilqs4axp6******",
          "ActionType": "TrafficMirror"
        }
      ]
    }
  ],
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    403 Forbidden.LoadBalancer Authentication is failed for %s.
    404 ResourceNotFound.LoadBalancer The specified resource %s is not found.
    404 ResourceNotFound.Listener The specified resource %s is not found.

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

    変更履歴

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