使用GetListenerHealthStatus查询监听健康检查状态-负载均衡-阿里云

查询负载均衡实例监听的健康检查状态。

调试

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

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
gwlb:GetListenerHealthStatus	get	LoadBalancer `acs:gwlb:{#regionId}:{#accountId}:loadbalancer/{#LoadbalancerId}` Listener `acs:gwlb:{#regionId}:{#accountId}:listener/{#ListenerId}`	无	无

请求参数

名称	类型	必填	描述	示例值
ListenerId	string	是	监听 ID。	lsn-7sixpvm5fc3v0b****
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：如果 NextToken 为空表示没有下一次查询。如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。	4f1d7cc9f51e18904e8a063603a6b0c3d03bc69f78734254e0b5e8707e68****
MaxResults	integer	否	分批次查询时每次显示的条目数。取值范围：1~1000，默认值为 20。	20
Skip	integer	否	分页查询时，跳过的条目数。	10
Filter	array<object>	否	动态查询条件列表。一次最多添加 20 个动态查询条件。
	object	否	动态查询条件。
Name	string	否	动态查询条件名称，可选择一个或者多个名称进行查询。取值范围： Status：健康检查状态。 ReasonCode：Status 为异常状态时的详细原因。 ServerId：后端服务器 ID。 ServerIp：后端服务器 IP 地址。	Status
Values	array	否	动态查询条件的值列表。一次最多添加 20 个值。
	string	否	动态查询条件的值。取值范围参考返回参数中相应字段的取值。	Unhealthy

返回参数

名称	类型	描述	示例值
	object	请求的返回值。
ListenerHealthStatus	array<object>	监听的服务器组健康检查状态列表。
listenerHealthStatus	object	监听的服务器组健康检查状态结构。
ListenerId	string	监听 ID。	lsn-sg8aha6pzjavvo****
ServerGroupInfos	array<object>	服务器组信息列表。
ServerGroupInfo	object	服务器组信息。
HealthCheckEnabled	boolean	是否开启健康检查。取值： true：开启。 false：关闭。	true
ServerGroupId	string	服务器组 ID。	sgp-0vdsbyszro3nr6****
Servers	array<object>	后端服务器列表。
server	object	后端服务器。
Port	integer	后端服务器端口。	6081
Reason	object	Status 为异常状态时的详细原因。
ReasonCode	string	Status 为异常状态时的详细原因，取值： CONNECT_TIMEOUT：负载均衡健康检查时向后端服务器建立连接超时。 CONNECT_FAIL：负载均衡健康检查时向后端服务器建立连接失败。 RECV_TIMEOUT：负载均衡健康检查时从后端服务器接收响应超时。 CONNECT_INTERRUPT：负载均衡健康检查与后端服务器连接中断。 HTTP_CODE_NOT_MATCH：负载均衡健康 HTTP 检查时从后端服务器接收的响应码与预期配置返回码不一致。 HTTP_INVALID_HEADER：负载均衡健康 HTTP 检查时从后端服务器接收响应格式错误。	CONNECT_TIMEOUT
ServerId	string	后端服务器 ID。	i-2ze4rnh8yj9kif3z****
ServerIp	string	后端服务器 IP。	192.168.0.XXX
Status	string	后端服务器健康检查状态。取值： Initial：初始化中，表示负载均衡实例配置了健康检查，但查不到数据。 Unhealthy：异常，表示连续上报不健康的状态。 Unused：未使用; Unavailable：未开启，表示未开启健康检查； Healthy：健康检查正常；	Healthy
MaxResults	integer	分批次查询时每次显示的条目数。取值范围：1~1000，默认值为 20。	20
NextToken	string	是否拥有下一次查询的令牌（Token）。取值：如果 NextToken 为空表示没有下一次查询。如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。	U12WEI6Ro2ol3wA54rBNSwdC5+lYy6q5SjIQEvc1wz5mjZxV+YjsHRdXV8XauY1BpOQIvwX63E0en54H3D****
RequestId	string	请求 ID。	0ED4F222-36A0-5470-8A9A-AAB4E96BAC1A
TotalCount	integer	本次请求条件下的数据总量。	31

示例

正常返回示例

JSON格式

{
  "ListenerHealthStatus": [
    {
      "ListenerId": "lsn-sg8aha6pzjavvo****",
      "ServerGroupInfos": [
        {
          "HealthCheckEnabled": true,
          "ServerGroupId": "sgp-0vdsbyszro3nr6****",
          "Servers": [
            {
              "Port": 6081,
              "Reason": {
                "ReasonCode": "CONNECT_TIMEOUT"
              },
              "ServerId": "i-2ze4rnh8yj9kif3z****",
              "ServerIp": "192.168.0.XXX",
              "Status": "Healthy"
            }
          ]
        }
      ]
    }
  ],
  "MaxResults": 20,
  "NextToken": "U12WEI6Ro2ol3wA54rBNSwdC5+lYy6q5SjIQEvc1wz5mjZxV+YjsHRdXV8XauY1BpOQIvwX63E0en54H3D****",
  "RequestId": "0ED4F222-36A0-5470-8A9A-AAB4E96BAC1A",
  "TotalCount": 31
}

错误码

HTTP status code	错误码	错误信息	描述
400	IllegalParam.FilterValue	The param of %s is illegal.	动态查询条件的值非法
400	IllegalParam.FilterName	The param of %s is illegal.	动态查询条件名称非法
404	ResourceNotFound.Listener	The specified resource of %s is not found.	指定的监听资源不存在

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