DescribeListenerHealth--负载均衡-火山引擎

文档中心

立即注册

导航

DescribeListenerHealth

最近更新时间：2024.10.21 14:07:13首次发布时间：2021.08.31 10:37:27

调用 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	Boolean	否	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	Array of Struct	-	符合条件的后端服务器的详细信息。具体请参见下表“ Results ”。

Results

名称	类型	示例值	描述
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	后端服务器的更新时间。

请求示例

GET /?Action=DescribeListenerHealth&Version=2020-04-01&ListenerId=lsn-2fek3rgsxhrsw5oxruwec****&PageSize=20&PageNumber=1&OnlyUnHealthy=true HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: clb

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20210811152539010225146063030****",
        "Action": "DescribeListenerHealth",
        "Version": "2020-04-01",
        "Service": "clb",
        "Region": "cn-beijing"
    },   
     "Result": {
        "RequestId": "20210811152539010225146063030****",
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 1,
        "UnHealthyCount": 1,
        "Status": "Error",
        "Results": [
            {
                "ServerId": "rs-2fel9yaoyv75s5oxruux5****",
                "InstanceId": "i-3tm18xqalm4e8i4q****",
                "ServerGroupId": "rsp-bp1o94dp5i6ea****",
                "Type": "ecs",
                "Ip": "192.XX.XX.8",
                "Port": 1,
                "RuleNumber": 1,
                "Status": "Down",
                "UpdatedAt": "2021-10-23T01:37:38Z"
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HttpCode	错误码	错误信息	描述
400	InvalidPaging.Malformed	The specified PageNumber or PageSize is malformed.	指定的分页参数格式不合法。
404	InvalidListener.NotFound	The specified Listener does not exist.	指定的监听器不存在。