文档中心

负载均衡

CLB-监听器

DescribeListenerHealth - 查询监听器后端服务器健康检查信息

调用 DescribeListenerHealth 接口，查询指定监听器关联的后端服务器的健康检查信息。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

Action String 必选示例值：DescribeListenerHealth

要执行的操作，取值：DescribeListenerHealth。

Version String 必选示例值：2020-04-01

API的版本信息，当前版本为 2020-04-01。

ListenerId String 必选示例值：lsn-2fek3rgsxhrsw5oxruwec****

监听器ID。

您可以调用DescribeListeners接口，查询监听器ID。

OnlyUnHealthy String 可选示例值：true

配置是否仅返回健康检查状态“异常”的后端服务器组信息。

请严格按照以下枚举值的大小写输入，不要传入其他取值。

true：仅返回“异常”的后端服务器组信息。

false：返回所有状态的后端服务器组信息。

PageNumber Integer 可选示例值：1

列表的页码，默认值为1。

PageSize Integer 可选示例值：20

分页查询时每页的行数，取值范围为1～100，默认为10。

返回参数

RequestId String 示例值：20210811152539010225146063030****

请求ID

PageSize Integer 示例值：20

当前分页的行数。

PageNumber Integer 示例值：1

当前页码。

TotalCount Integer 示例值：50

符合条件的后端服务器总数。

UnHealthyCount Integer 示例值：3

符合条件且健康检查状态为“异常”的后端服务器总数。

Status String 示例值：Active

监听器健康检查的状态。

Active：正常。

Error：异常。

Disabled：未开启，表示未开启健康检查。

NoTarget：无目标，表示未配置后端服务器。

Results Object[] 示例值：-

符合条件的后端服务器的详细信息。

ServerId String 示例值：rs-2fel9yaoyv75s5oxruux5****

后端服务器ID。

Type String 示例值：ecs

后端服务器的类型。

ecs：云服务器。

eni：网卡。

InstanceId String 示例值：i-3tm18xqalm4e8i4q****

云服务器实例或网卡的ID。

Ip String 示例值：192.XX.XX.8

后端服务器的IP地址。

Port Integer 示例值：443

后端服务器的端口号。

RuleNumber Integer 示例值：12

后端服务器关联的转发规则数。TCP/UDP监听器返回为0。

ServerGroupId String 示例值：rsp-bp1o94dp5i6ea****

后端服务器所属服务器组ID。

Status String 示例值：Down

后端服务器的状态。

Up：正常。

Down：异常。

UpdatedAt String 示例值：2019-04-23T01:37:38Z

后端服务器的更新时间。

请求示例

返回示例

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

状态码	错误码	错误信息	说明
400	InvalidPageNumber.Malformed	The specified PageNumber is malformed.	指定的 PageNumber 参数格式不合法。
400	InvalidPageSize.Malformed	The specified PageSize is malformed.	指定的 PageSize 参数格式不合法。
400	InvalidPaging.Malformed	The specified PageNumber or PageSize is malformed.	指定的分页参数格式不合法。
400	MissingParameter	The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, the 'ListenerId'.	该请求缺少必要参数。请确保发起请求已提供全部必要参数，比如 ListenerId。
400	MissingParameter	The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, the ''.	该请求缺少必要参数。请确保发起请求已提供全部必要参数，比如。
404	InvalidListener.NotFound	The specified Listener does not exist.	指定的监听器不存在。
500	InternalError	An internal error has occurred.	发生内部错误。

最近更新时间：2026.02.13 10:32:58

这个页面对您有帮助吗？

有用

无用