查询网络型负载均衡实例监听的健康检查状态。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| nlb:GetListenerHealthStatus | Read |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ListenerId | string | 是 | 网络型负载均衡实例的监听 ID。 | lsn-bp1bpn0kn908w4nbw**** |
| NextToken | string | 否 | 是否拥有下一次查询的令牌（Token）。取值：
| FFmyTO70tTpLG6I3FmYAXGKPd**** |
| MaxResults | integer | 否 | 分批次查询时每次显示的条目数。取值范围：1~100，默认值为 20。 | 20 |
| RegionId | string | 否 | 网络型负载均衡实例所在的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-hangzhou |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
"ListenerHealthStatus": [
{
"ListenerId": "lsn-agkd9gmjx8nd85jjs0****",
"ListenerPort": 80,
"ListenerProtocol": "TCPSSL",
"ServerGroupInfos": [
{
"HeathCheckEnabled": true,
"ServerGroupId": "sgp-ppdpc14gdm3x4o****",
"NonNormalServers": [
{
"Status": "Initial",
"Port": 80,
"Reason": {
"ReasonCode": "CONNECT_TIMEOUT"
},
"ServerId": "i-bp1bt75jaujl7tjl****",
"ServerIp": "192.168.8.10"
}
]
}
]
}
],
"TotalCount": 10,
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"MaxResults": 20
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | SystemBusy | System is busy, please try again later. | 系统繁忙，请稍后重试 |
| 403 | Forbidden.NoPermission | Authentication is failed for NoPermission. | 因为账号没有权限，所以鉴权失败。 |
| 404 | ResourceNotFound.loadBalancer | The specified resource of loadbalancer is not found. | 找不到指定的负载均衡器资源，请检查输入参数。 |
| 404 | ResourceNotFound.listener | The specified resource %s is not found. | 资源%s不存在。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 2023-10-10 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2023-10-09 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2023-09-26 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2023-09-13 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
|