You need to enable JavaScript to run this app.
导航
负载均衡
  • 文档首页
    • /
  • 负载均衡

DescribeListenerHealth

最近更新时间：2024.01.12 10:21:37

首次发布时间：2021.08.31 10:37:27

我的收藏

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

调试

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

请求参数

名称类型是否必填示例值
描述
ActionString是DescribeListenerHealth要执行的操作，取值为DescribeListenerHealth。
VersionString是2020-04-01API版本信息，当前版本为：2020-04-01。
ListenerIdString是lsn-2fek3rgsxhrsw5oxruwec****监听器ID。您可以调用DescribeListeners接口获取监听器ID。

OnlyUnHealthy

Boolean

否

true

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

  • true：仅返回“异常”的后端服务器组信息。
  • false：返回所有状态的后端服务器组信息。
PageSizeInteger否20分页查询时每页的行数，取值范围为1～100，默认为10。
PageNumberInteger否1列表的页码，默认值为1。

返回参数

字段类型示例值
描述
RequestIdString20210811152539010225146063030****请求ID
PageSizeInteger20当前分页的行数。
PageNumberInteger1当前页码。
TotalCountInteger50符合条件的后端服务器总数。
UnHealthyCountInteger3符合条件且健康检查状态为“异常”的后端服务器总数。

Status

String

Active

监听器健康检查的状态。取值如下：

  • Active：正常
  • Error：异常
  • Disabled：未开启，表示未开启健康检查。
  • NoTarget：无目标，表示未配置后端服务器。
ResultsArray of Struct-符合条件的后端服务器的详细信息。具体请参见下表“ Results ”。

Results

字段类型示例值
描述
ServerIdStringrs-2fel9yaoyv75s5oxruux5****后端服务器ID。
InstanceIdStringi-3tm18xqalm4e8i4q****云服务器实例或网卡的ID。

Type

String

ecs

后端服务器的类型。

  • ecs：云服务器。
  • eni：网卡。
IpString192.XX.XX.8后端服务器的IP地址。
PortInteger443后端服务器的端口号。
RuleNumberInteger12后端服务器关联的转发规则数。TCP/UDP监听器返回为0。
ServerGroupIdStringrsp-bp1o94dp5i6ea****后端服务器所属服务器组ID。

Status

String

Down

后端服务器的状态。

  • Up：正常。
  • Down：异常。
UpdatedAtString2019-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

MissingParameter

The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, the 'XXX'.

该请求缺少必要参数。请确保发起请求已提供全部必要参数，比如XXX。

说明

其中，XXX表示缺少的参数名称。

400InvalidPaging.MalformedThe specified PageNumber or PageSize is malformed.指定的分页参数格式不合法。
404InvalidListener.NotFoundThe specified Listener does not exist.指定的监听器不存在。