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

文档中心

导航

DescribeNLBListenerHealth

最近更新时间：2024.12.04 17:10:14首次发布时间：2024.12.04 17:10:14

调用 DescribeNLBListenerHealth 接口，查询监听器关联的后端服务器的健康状态。

请求参数

名称	类型	是否必选	示例值	说明
Action	String	是	DescribeNLBListenerHealth	要执行的操作，取值为DescribeNLBListenerHealth。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
ListenerId	String	是	lsn-2fek3rgsxhrsw5oxruwec****	监听器ID。您可以调用DescribeNLBListeners接口获取监听器ID。
MaxResult	Integer	否	10	分页查询时每页的行数，取值范围为1 ~ 100，默认值为20。
NextToken	string	否	caeba0bbb2be03f84eb48b699f0a****	分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次API调用返回的`NextToken`参数值。

返回参数

名称	类型	示例值	描述
RequestId	String	2024092952539010225146063030****	请求ID。
NextToken	String	caeba0bbb2be03f84eb48b699f0a****	本次调用返回的查询凭证值，返回为空表示没有下一页。
ListenerId	String	lsn-defyhgsiy5jggkl****	监听器 ID。
ServerGroupId	String	rsp-qwsdjekl67tgh****	服务器组 ID。
HealthyCount	Integer	1	服务器组中健康的后端服务器数量。
UnhealthyCount	Integer	0	服务器组中异常的后端服务器数量。
Status	String	Active	服务器组的状态。 NoTarget：包括以下两种场景：服务器组中未添加后端服务器服务器组已关闭跨可用区转发，且组中无访问流量对应可用区的后端服务器。 Error：服务器组中存在异常的后端服务器。 Active：服务器组中所有后端服务器均健康。 Disabled：包括以下两种场景：服务器组已关闭健康检查。服务器组关联的NLB实例处于被关停状态。
Results	Array of Struct	--	符合条件的后端服务器的详细信息。具体请参见下表“ Results ”。

Results

名称	类型	示例值	描述
ServerId	String	rs-2fel9yaoyv75s5oxruux5****	后端服务器ID。
ServerType	String	eni	后端服务器的类型。 ecs：云服务器实例（即主网卡） eni：辅助网卡 ip：IP地址
InstanceId	String	eni-e3elrfaaqverf5oedru3r****	后端服务器的实例 ID或IP地址。
ZoneId	String	cn-guangzhou-a	后端服务器接收哪些可用区的访问流量。
Ip	String	192.XX.XX.8	后端服务器的IP地址。
Port	Integer	443	后端服务器提供服务的端口。
Status	String	Down	后端服务器的健康状态。 Up：正常。 Down：异常。 Unused：未被使用。NLB实例已关闭跨可用区转发，且没有来自该后端服务器可用区的访问流量。

请求示例

GET /?Action=DescribeNLBListenerHealth&Version=2020-04-01&ListenerId=lsn-2fek3rgsxhrsw5oxruwec**** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-guangzhou
Service: clb

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024092952539010225146063030****",
        "Action": "DescribeNLBListenerHealth",
        "Version": "2020-04-01",
        "Service": "clb",
        "Region": "cn-guangzhou"
    },   
     "Result": {
        "RequestId": "2024092952539010225146063030****",
        "NextToken": "",
        "ListenerId": "lsn-2fe5agi01myo059gp68d4****",
        "ServerGroupId": "rsp-2fe5afscd6nls59gp67fk****",
        "HealthyCount": 1,
        "UnhealthyCount": 0,
        "Status": "Error",
        "Results": [
            {
                "ServerId": "rs-2fe5ag46tuku859gp67lb****",
                "InstanceId": "i-yddygw0cn4h9l3bp****",
                "ServerType": "ecs",
                "Ip": "192.XX.XX.5",
                "Port": 80,
                "ZoneId": "cn-guangzhou-a",
                "Status": "Down",
                "UpdateTime": "2024-09-25T06:45:12Z"
            }
        ]
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。