调用 DescribeListenerHealth 接口查询指定监听器关联的后端服务器的健康检查信息。
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeListenerHealth | 要执行的操作,取值为DescribeListenerHealth。 |
Version | String | 是 | 2020-04-01 | API版本信息,当前版本为:2020-04-01。 |
ListenerId | String | 是 | lsn-2fek3rgsxhrsw5oxruwec**** | 监听器ID。 |
OnlyUnHealthy | Boolean | 否 | true | 配置是否仅返回健康检查状态“异常”的后端服务器组信息。
|
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 | 监听器健康检查的状态。
|
Results | Array of Struct | - | 符合条件的后端服务器的详细信息。具体请参见下表“ Results ”。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ServerId | String | rs-2fel9yaoyv75s5oxruux5**** | 后端服务器ID。 |
Type | String | ecs | 后端服务器的类型。
|
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 | 后端服务器的状态。
|
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 | 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表示缺少的参数名称。 |
400 | InvalidPaging.Malformed | The specified PageNumber or PageSize is malformed. | 指定的分页参数格式不合法。 |
404 | InvalidListener.NotFound | The specified Listener does not exist. | 指定的监听器不存在。 |