全部产品
Search

搜索本产品

    全球加速：GetHealthStatus - 获取监听下终端节点组和终端节点的健康状态

    文档中心

    全球加速：GetHealthStatus - 获取监听下终端节点组和终端节点的健康状态

    更新时间：Aug 27, 2026

    调用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

    是

    全球加速实例所属的地域 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

    是

    全球加速实例 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"
        }
      ]
    }
  ]
}

    错误码

    访问错误中心查看更多错误码。

    变更历史

    更多信息，参考变更详情。