文档

GetListenerHealthStatus - 查询健康检查

更新时间:

查询监听及其转发规则的健康检查状态。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
alb:GetListenerHealthStatusRead
  • LoadBalancer
    acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

请求参数

名称类型必填描述示例值
ListenerIdstring

实例的监听 ID。

lsn-o4u54y73wq7b******
IncludeRuleboolean

是否包含转发规则的检查结果。取值:

  • true:是。
  • false(默认值):否。
true
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。
FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultslong

分批次查询时每次显示的最大条目数。取值范围:1~30,默认值为 20

20

返回参数

名称类型描述示例值
object

查询监听及其相应配置的转发规则的健康检查状态。

ListenerHealthStatusobject []

监听的服务器组健康检查状态列表。

ListenerIdstring

实例的监听 ID。

lsn-o4u54y73wq7b******
ListenerPortinteger

监听的端口号。

80
ListenerProtocolstring

监听的协议。

http
ServerGroupInfosobject []

服务器组信息。

HealthCheckEnabledstring

健康检查开启状态。取值: on,表示开启健康检查。

on
NonNormalServersobject []

非正常状态的后端服务器列表。

Portinteger

后端服务器端口。

90
Reasonobject

非正常状态的原因。

ActualResponsestring

后端服务器实际的返回码信息,例如,302

说明 ReasonCodeRESPONSE_MISMATCH才该返回值。
302
ExpectedResponsestring

用户预期的后端服务器返回码信息。

取值:HTTP_2xxHTTP_3xxHTTP_4xxHTTP_5xx。多个返回码之间用半角逗号(,)分隔。

说明 ReasonCodeRESPONSE_MISMATCH才返回该值。
HTTP_2xx
ReasonCodestring

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
ServerIdstring

后端服务器 ID。

i-uf62h8v******
ServerIpstring

后端服务器 IP。

192.168.8.10
Statusstring

健康检查状态。取值:

  • Initial:初始化中,表示负载均衡实例配置了健康检查,但查不到数据。

  • Unhealthy:异常,表示连续上报不健康的状态。

  • Unused:未使用,表示后端服务器的权重为 0。

  • Unavailable:未开启,表示未开启健康检查。

Initial
ServerGroupIdstring

关联的服务器组 ID。

sgp-8ilqs4axp6******
ActionTypestring

服务器组使用类型。

TrafficMirror
RequestIdstring

请求 ID。

CEF72CEB-54B6-4AE8-B225-F876F******
RuleHealthStatusobject []

转发规则的健康状态列表。

RuleIdstring

转发规则 ID。

rule-hp34s2h0xx1ht4nwo****
ServerGroupInfosobject []

服务器组列表。

HealthCheckEnabledstring

健康检查开启状态。取值: on,表示开启健康检查。

on
NonNormalServersobject []

非正常状态的后端服务器列表。

Portinteger

后端服务器端口。

90
Reasonobject

非正常状态的原因。

ActualResponsestring

后端服务器实际的返回码信息,例如,302

说明 ReasonCodeRESPONSE_MISMATCH才有值。
302
ExpectedResponsestring

用户预期的后端服务器返回码信息。

取值:HTTP_2xxHTTP_3xxHTTP_4xxHTTP_5xx。多个返回码之间用半角逗号(,)分隔。

说明 ReasonCodeRESPONSE_MISMATCH才有值。
HTTP_2xx
ReasonCodestring

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
ServerIdstring

后端服务器 ID。

i-uf62h8v******
ServerIpstring

后端服务器组 IP。

192.168.2.11
Statusstring

健康检查状态。取值:

  • Initial:初始化中,表示负载均衡实例配置了健康检查,但查不到数据。

  • Unhealthy:异常,表示连续上报不健康的状态。

  • Unused:未使用,表示后端服务器的权重为 0。

  • Unavailable:未开启,表示未开启健康检查。

Initial
ServerGroupIdstring

关联的服务器组 ID。

sgp-8ilqs4axp6******
ActionTypestring

服务器组使用类型。

TrafficMirror
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 如果 NextToken 为空表示没有下一次查询。
  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。
FFmyTO70tTpLG6I3FmYAXGKPd****

示例

正常返回示例

JSON格式

{
  "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 status code错误码错误信息描述
403Forbidden.LoadBalancerAuthentication is failed for %s.负载均衡操作鉴权失败。
404ResourceNotFound.LoadBalancerThe specified resource %s is not found.资源%s不存在。
404ResourceNotFound.ListenerThe specified resource %s is not found.资源%s不存在。

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

变更历史

变更时间变更内容概要操作
2024-01-29OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
    新增错误码:403