すべてのプロダクト
Search

このプロダクト

    :GetListenerHealthStatus

    ドキュメントセンター

    :GetListenerHealthStatus

    最終更新日:Dec 19, 2025

    リスナーとその転送ルールのヘルスチェックステータスを照会します。

    今すぐお試しください

    この 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

    サーバーから返された HTTP ステータスコード (例：302)。

    説明

    ReasonCode が RESPONSE_MISMATCH に設定されている場合にのみ値が返されます。

    302
    ExpectedResponse

    string

    バックエンドサーバーがヘルスチェックに合格した後に返される HTTP ステータスコード。

    有効な値：HTTP_2xx、HTTP_3xx、HTTP_4xx、HTTP_5xx。複数のステータスコードはカンマ (,) で区切ります。

    説明

    この値は、ReasonCode が RESPONSE_MISMATCH に設定されている場合にのみ返されます。

    HTTP_2xx
    ReasonCode

    string

    Status の値が Unhealthy である理由。HTTP リスナーと HTTPS リスナーのみがこのパラメーターをサポートします。

    • CONNECT_TIMEOUT：ALB が指定された期間内にバックエンドサーバーに接続できませんでした。

    • CONNECT_FAILED：ALB がバックエンドサーバーに接続できませんでした。

    • RECV_RESPONSE_FAILED：ALB がバックエンドサーバーから応答を受信できませんでした。

    • RECV_RESPONSE_TIMEOUT：ALB が指定された期間内にバックエンドサーバーから応答を受信できませんでした。

    • SEND_REQUEST_FAILED：ALB がバックエンドサーバーにリクエストを送信できませんでした。

    • SEND_REQUEST_TIMEOUT：ALB が指定された期間内にバックエンドサーバーにリクエストを送信できませんでした。

    • RESPONSE_FORMAT_ERROR：バックエンドサーバーからの応答のフォーマットが無効です。

    • RESPONSE_MISMATCH：バックエンドサーバーから返された HTTP ステータスコードが期待されたものではありません。

    RESPONSE_MISMATCH
    ServerId

    string

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

    i-uf62h8v******
    ServerIp

    string

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

    192.168.8.10
    Status

    string

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

    • Initial：NLB インスタンスにヘルスチェックが設定されていますが、データが見つからないことを示します。

    • Unhealthy：バックエンドサーバーが連続してヘルスチェックに失敗したことを示します。

    • Unused：バックエンドサーバーの重みが 0 であることを示します。

    • 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

    サーバーから返された HTTP ステータスコード (例：302)。

    説明

    ReasonCode が RESPONSE_MISMATCH に設定されている場合にのみ値が返されます。

    302
    ExpectedResponse

    string

    バックエンドサーバーがヘルスチェックに合格した後に返される HTTP ステータスコード。

    有効な値：HTTP_2xx、HTTP_3xx、HTTP_4xx、HTTP_5xx。複数のステータスコードはカンマ (,) で区切ります。

    説明

    ReasonCode が RESPONSE_MISMATCH に設定されている場合にのみ値が返されます。

    HTTP_2xx
    ReasonCode

    string

    Status の値が Unhealthy である理由。HTTP および HTTPS リスナーの転送ルールのみがこのパラメーターをサポートします。

    • CONNECT_TIMEOUT：ALB が指定された期間内にバックエンドサーバーに接続できませんでした。

    • CONNECT_FAILED：ALB がバックエンドサーバーに接続できませんでした。

    • RECV_RESPONSE_FAILED：ALB がバックエンドサーバーから応答を受信できませんでした。

    • RECV_RESPONSE_TIMEOUT：ALB が指定された期間内にバックエンドサーバーから応答を受信できませんでした。

    • SEND_REQUEST_FAILED：ALB がバックエンドサーバーにリクエストを送信できませんでした。

    • SEND_REQUEST_TIMEOUT：ALB が指定された期間内にバックエンドサーバーにリクエストを送信できませんでした。

    • RESPONSE_FORMAT_ERROR：バックエンドサーバーからの応答のフォーマットが無効です。

    • RESPONSE_MISMATCH：バックエンドサーバーから返された HTTP ステータスコードが期待されたものではありません。

    RESPONSE_MISMATCH
    ServerId

    string

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

    i-uf62h8v******
    ServerIp

    string

    サーバーグループの IP アドレス。

    192.168.2.11
    Status

    string

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

    • Initial：NLB インスタンスにヘルスチェックが設定されていますが、データが見つからないことを示します。

    • Unhealthy：バックエンドサーバーが連続してヘルスチェックに失敗したことを示します。

    • Unused：バックエンドサーバーの重みが 0 であることを示します。

    • Unavailable：ヘルスチェックが無効になっていることを示します。

    Initial
    ServerGroupId

    string

    リスナーに関連付けられているサーバーグループの ID。

    sgp-8ilqs4axp6******
    ActionType

    string

    サーバーグループに指定されたアクション。

    TrafficMirror
    NextToken

    string

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

    • NextToken が空の場合、次のページはありません。

    • 前のクエリで NextToken が返された場合は、その値を指定して次の結果セットを取得します。

    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.

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

    変更履歴

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