全部產品
Search

搜尋本產品

    Global Accelerator：GetHealthStatus - 擷取監聽下終端節點群組和終端節點的健康狀態

    文件中心

    Global Accelerator：GetHealthStatus - 擷取監聽下終端節點群組和終端節點的健康狀態

    更新時間：Dec 14, 2025

    調用GetHealthStatus介面擷取指定監聽下終端節點群組和終端節點的健康狀態資訊。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    ga:GetHealthStatus

    get

    *Listener

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    是

    Global Acceleration執行個體所屬的地區 ID，僅取值：cn-hangzhou。

    cn-hangzhou
    ClientToken

    string

    否

    用戶端 Token，用於保證請求的等冪性。

    由用戶端產生該參數值，要保證在不同請求間唯一，最大值不超過 64 個 ASCII 字元。

    說明

    若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。

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

    boolean

    否

    是否只預檢此次請求，取值：

    • true：發送檢查請求，不會擷取監聽執行個體的健康狀態資訊。檢查項包括是否填寫了必需參數、請求格式、業務限制。如果檢查不通過，則返回對應錯誤。如果檢查通過，則返回錯誤碼DryRunOperation。

    • false（預設值）：發送正常請求，通過檢查後返回 HTTP 2xx 狀態代碼並擷取監聽執行個體的健康狀態資訊。

    true
    AcceleratorId

    string

    是

    Global Acceleration執行個體 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

    終端節點地址。

    47.0.XX.XX
    HealthStatus

    string

    終端節點的健康狀態。取值：

    • init：初始化

    • normal：正常。

    • abnormal：異常。

    normal
    HealthDetail

    string

    終端節點的健全狀態檢查明細。

    說明

    該參數暫未啟用。

    無
    Port

    integer

    終端節點的連接埠。

    80
    Type

    string

    終端節點類型。取值：

    • Domain：自訂網域名。

    • Ip：自訂 IP。

    • PublicIp：阿里雲公網 IP。

    • ECS：阿里雲 ECS 執行個體。

    • SLB：阿里雲 CLB 執行個體（原 SLB）。

    • ALB：阿里雲 ALB 執行個體。

    • OSS：阿里雲 OSS 執行個體。

    • ENI：阿里雲彈性網卡。

    • NLB：阿里雲 NLB 執行個體。

    Ip

    樣本

    正常返回樣本

    JSON格式

    {
  "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"
        }
      ]
    }
  ]
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。