DescribeListenerHealth--应用型负载均衡-火山引擎

文档中心

立即注册

导航

DescribeListenerHealth

最近更新时间：2024.06.28 16:26:01首次发布时间：2022.05.20 22:12:48

请求说明

API 名称：DescribeListenerHealth 。
API 域名：open.volcengineapi.com 。
API 描述：查询指定监听器关联后端服务器的健康检查信息。

使用限制

节流限制：每秒最多提交 40 个 API 请求。

调试

API Explorer

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

去调试

URI 参数

在使用该部分 API 提交请求时必须包含以下 URI 参数。

除了 URI 参数，该 API 请求还需要包含签名参数。关于更多签名参数的信息，参见公共请求参数。

名称	类型	是否必选	格式	说明
Action	string	是	[a-zA-Z]+	API 名称，如 DescribeListenerHealth。
Version	string	是	YYYY-MM-DD	API 版本信息。该参数的取值是 2020-04-01 。
X-Expires	int	否	900	表示签名的有效时间，单位是秒，默认值是900。

请求参数

在使用该 API 提交请求时，请求参数中可以包含的参数如下。

参数	类型	是否必选	参数说明	示例值
ListenerIds.N	List of String	是	监听器ID数组，最多一次可查10个，多个监听器间使用“&”分隔。 - N：表示监听器的序号，取值范围为1 ～ 10。	ListenerIds.1=lsn-abc***&ListenerIds.2=lsn-def*****
OnlyUnHealthy	Boolean	否	配置是否仅返回健康检查状态“异常”的后端服务器信息，取值如下： false 。 true（默认）。	true
ProjectName	String	否	监听器所属项目名称。	default

参数

类型

是否必选

参数说明

示例值

ListenerIds.N

List of String

是

监听器ID数组，最多一次可查10个，多个监听器间使用“&”分隔。 - N：表示监听器的序号，取值范围为1 ～ 10。

ListenerIds.1=lsn-abc*****&ListenerIds.2=lsn-def*******

OnlyUnHealthy

Boolean

否

配置是否仅返回健康检查状态“异常”的后端服务器信息，取值如下：

false 。
true（默认）。

true

ProjectName

String

否

监听器所属项目名称。

default

返回参数

参数	类型	参数说明	示例值
RequestId	String	请求 ID。	20210816110638****2514606306AF947C
TotalCount	Integer	本次查询的监听器总数。	26
Listeners	Array	具体请参见下表 Listeners 。	-

Listeners

参数	类型	参数说明	示例值
ListenerId	String	监听器 ID 。	lsn-12344***765
TotalBackendServerCount	Integer	监听器下后端服务器总数。	50
UnHealthyCount	Integer	健康检查状态为异常的后端服务器总数。	3
Status	String	监听器状态，支持： Active：正常。 Error：存在异常。 NoTarget：无目标。 Disabled：未开启。	Active
Results	Array	异常服务器的详情，具体请参见下表 Results 。	-

Results

参数	类型	参数说明	示例值
ServerId	String	后端服务器 ID。	rs-123****654
InstanceId	String	云服务器实例或者网卡的 ID。	i-123****765
Type	String	后端服务器的类型，支持： ecs（云服务器）。 eni（网卡）。	esc
Ip	String	后端服务器的 IP 地址。	192.168.0.1
Port	Integer	后端服务器的端口号。	443
RuleNumber	Integer	后端服务器关联的转发规则数。	12
ServerGroupId	String	后端服务器所属服务器组 ID 。	rsp-123****765
ServerGroupName	String	后端服务器所属服务器组的名称。	服务器组1
Status	String	后端服务器的状态，支持： Up：正常。 Down：异常。	Down

示例

请求示例

GET /?Action=DescribeListenerHealth&Version=2020-04-01&ListenerIds.1=lsn-123***765&OnlyUnHealthy=true HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: alb

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021122917************14702044B16",
        "Action": "DescribeListenerHealth",
        "Version": "2020-04-01",
        "Service": "alb",
        "Region": "cn-beijing"
    },   
     "Result": {
        "RequestId": "20210816110638****2514606306AF947C",
        "Listeners": [
            {
                "ListenerId": "lsn-123****7654",
                "TotalCount": 1,
                "UnHealthyCount": 1,
                "Status": "Error",
                "Results": [
                    {
                        "ServerId": "rs-3ciw6son****46c6rrtl3tpi3",
                        "InstanceId": "i-3tli51pv****j0wuvaeh",
                        "ServerGroupId": "rsp-2fe5fl3****405oxruwbagicr",
                        "Type": "ecs",
                        "Ip": "172.16.1.242",
                        "Port": 1,
                        "RuleNumber": 1,
                        "Status": "Down"
                    }
                 ]
            }
        ]
        
     }
}

错误码

如果响应正文包含 Error 字段，则表示 API 请求失败。此处仅展示当前 API 的错误码，更多错误码请参见公共错误码。

HTTP Code	错误码	错误信息	错误描述
400	LimitExceed.Listener	You've reached the limit on the number of listeners that you can operate at a time.	已达到单次可操作的监听器的数量上限。
404	InvalidListener.NotFound	The specified Listener does not exist.	指定的监听器不存在。