すべてのプロダクト
Search

このプロダクト

    :GetHealthStatus

    ドキュメントセンター

    :GetHealthStatus

    最終更新日:Dec 14, 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    ga:GetHealthStatus

    get

    *Listener

    acs:ga:{#regionId}:{#accountId}:listener/{#listenerId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    Global Accelerator (GA) インスタンスがデプロイされているリージョンの ID。値を cn-hangzhou に設定します。

    cn-hangzhou
    ClientToken

    string

    任意

    リクエストのべき等性を保証するために使用されるクライアントトークンです。

    クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。

    説明

    このパラメーターを指定しない場合、システムは自動的にリクエスト ID をクライアントトークンとして使用します。リクエスト ID はリクエストごとに異なる場合があります。

    123e4567-e89b-12d3-a456-426655440000
    DryRun

    boolean

    任意

    リクエストを事前チェックするかどうかを指定します。有効な値：

    • true：リクエストの事前チェックのみを行います。リスナーのヘルスステータスは照会されません。システムは、必須パラメーター、リクエスト構文、および制限を事前チェックします。リクエストが事前チェックに失敗した場合、エラーメッセージが返されます。リクエストが事前チェックに合格した場合、DryRunOperation エラーコードが返されます。

    • false (デフォルト)：通常のリクエストを送信します。リクエストが事前チェックに合格すると、2xx HTTP ステータスコードが返され、リスナーのヘルスステータスが取得されます。

    true
    AcceleratorId

    string

    必須

    照会する GA インスタンスの ID。

    ga-bp1odcab8tmno0hdq****
    ListenerId

    string

    必須

    リスナーの ID。

    lsr-bp1bpn0kn908w4nbw****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーター。

    RequestId

    string

    リクエスト ID。

    64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF
    ListenerId

    string

    リスナーの ID。

    lsr-bp1bpn0kn908w4nbw****
    HealthStatus

    string

    エンドポイントとエンドポイントグループのヘルスステータス。有効な値：

    • normal：正常

    • abnormal：異常

    • partiallyAbnormal：部分的に異常

    normal
    EndpointGroups

    array<object>

    エンドポイントグループに関する情報。

    array<object>

    エンドポイントグループに関する情報。

    EndpointGroupId

    string

    エンドポイントグループの ID。

    epg-bp14sz7ftcwwjgrdm****
    EndpointGroupType

    string

    エンドポイントグループのタイプ。有効な値：

    • default：デフォルトのエンドポイントグループ。

    • virtual：仮想エンドポイントグループ。

    default
    HealthStatus

    string

    エンドポイントグループのヘルスステータス。有効な値：

    • init：エンドポイントグループは初期化中です。

    • normal：エンドポイントグループは正常です。

    • abnormal：エンドポイントグループは異常です。

    • partiallyAbnormal：エンドポイントグループは部分的に異常です。

    normal
    ForwardingRuleIds

    array

    転送ルールの ID。

    string

    転送ルールの ID。

    frule-bp134k63nmtwmnwee****
    Endpoints

    array<object>

    エンドポイントに関する情報。

    object

    エンドポイントに関する情報。

    EndpointId

    string

    エンドポイントの ID。

    ep-hp33b2e43fays7s8****
    Address

    string

    エンドポイントの IP アドレス。

    47.0.XX.XX
    HealthStatus

    string

    エンドポイントのヘルスステータス。有効な値：

    • init：エンドポイントは初期化中です。

    • normal：エンドポイントは正常です。

    • abnormal：エンドポイントは異常です。

    normal
    HealthDetail

    string

    エンドポイントのヘルスチェックの詳細。

    説明

    このパラメーターは利用できません。

    null
    Port

    integer

    エンドポイントへの接続に使用されるポート。

    80
    Type

    string

    エンドポイントのタイプ。有効な値：

    • Domain：カスタムドメイン名。

    • Ip：カスタム IP アドレス。

    • PublicIp：Alibaba Cloud が提供するパブリック IP アドレス。

    • ECS：Elastic Compute Service (ECS) インスタンス。

    • SLB：Classic Load Balancer (CLB) インスタンス。

    • ALB：Application Load Balancer (ALB) インスタンス。

    • OSS：Object Storage Service (OSS) バケット。

    • ENI：Elastic Network Interface (ENI)。

    • NLB：Network Load Balancer (NLB) インスタンス。

    Ip

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF",
  "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
  "HealthStatus": "normal",
  "EndpointGroups": [
    {
      "EndpointGroupId": "epg-bp14sz7ftcwwjgrdm****",
      "EndpointGroupType": "default",
      "HealthStatus": "normal",
      "ForwardingRuleIds": [
        "frule-bp134k63nmtwmnwee****"
      ],
      "Endpoints": [
        {
          "EndpointId": "ep-hp33b2e43fays7s8****",
          "Address": "47.0.XX.XX",
          "HealthStatus": "normal",
          "HealthDetail": "无",
          "Port": 80,
          "Type": "Ip"
        }
      ]
    }
  ]
}

    エラーコード

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

    変更履歴

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