You need to enable JavaScript to run this app.
文档中心
负载均衡

负载均衡

复制全文
下载 pdf
监听器
DescribeNLBListenerHealth - 查看后端服务器的健康状态
复制全文
下载 pdf
DescribeNLBListenerHealth - 查看后端服务器的健康状态
调用 DescribeNLBListenerHealth 接口,查询监听器关联的后端服务器的健康状态。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
Action String 必选 示例值:DescribeNLBListenerHealth​
要执行的操作,取值为 DescribeNLBListenerHealth。​
​
Version String 必选 示例值:2020-04-01​
API版本信息,当前版本为 2020-04-01。​
​
ListenerId String 必选 示例值:lsn-2fek3rgsxhrsw5oxruwec****​
监听器ID。​
您可以调用DescribeNLBListeners接口,获取监听器ID。​
​
NextToken String 可选 示例值:caeba0bbb2be03f84eb48b699f0a****​
分页查询凭证,用于标记分页的位置,初次调用该接口时无需设置。下次查询时,取值为上一次API调用返回的NextToken参数值。​
​
MaxResults Integer 可选 示例值:10​
查询的数量,默认为 10,最大为100。​
​
​
​
返回参数​
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 Object[] 示例值:--​
符合条件的后端服务器的详细信息。​
ServerId String 示例值:rs-2fel9yaoyv75s5oxruux5****​
后端服务器ID。​
​
ServerType String 示例值:eni​
后端服务器的类型。​
  • ecs:云服务器实例(即主网卡)​
  • eni:辅助网卡​
  • ip:IP地址​
​
InstanceId String 示例值:eni-e3elrfaaqverf5oedru3r****​
后端服务器的实例 ID或IP地址。​
​
ZoneId String 示例值:cn-beijing-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****&NextToken=caeba0bbb2be03f84eb48b699f0a****&MaxResults=10 HTTP/1.1​
Host: clb.cn-beijing.volcengineapi.com​
Date: 20260310T094038Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251121/cn-beijing/clb/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "DescribeNLBListenerHealth",​
"Version": "2020-04-01",​
"Service": "clb",​
"Region": "cn-beijing"​
},​
"Result": {​
"HealthyCount": 1,​
"ListenerId": "lsn-defyhgsiy5jggkl****",​
"NextToken": "caeba0bbb2be03f84eb48b699f0a****",​
"RequestId": "2024092952539010225146063030****",​
"Results": [​
{​
"Ip": "192.XX.XX.8",​
"Port": 443,​
"Status": "Down",​
"ZoneId": "cn-beijing-a",​
"ServerId": "rs-2fel9yaoyv75s5oxruux5****",​
"InstanceId": "eni-e3elrfaaqverf5oedru3r****",​
"ServerType": "eni"​
}​
],​
"ServerGroupId": "rsp-qwsdjekl67tgh****",​
"Status": "Active",​
"UnhealthyCount": 0​
}​
}​
​
错误码​
此处仅展示当前API的错误码,更多错误码请参见公共错误码。​
​
状态码​
错误码​
错误信息​
说明​
400​
DryRunOperation​
Exception raised to indicate a successfully authorized action when the DryRun flag is set to true.​
该请求设置为DryRun操作,操作授权已获得许可,但未被实际执行。​
400​
IdempotentParameterMismatch​
Arguments on this idempotent request are inconsistent with arguments used in previous request(s).​
此幂等请求的参数与前一个请求中使用的参数不一致。​
400​
InvalidClientToken.Malformed​
The specified ClientToken is malformed.​
指定的 ClientToken 参数格式不合法。​
400​
InvalidMaxResult.Malformed​
The specified MaxResult is malformed.​
指定的 MaxResult 参数格式不合法。​
400​
InvalidMaxResults.Malformed​
The specified MaxResults is malformed.​
指定的 MaxResults 参数格式不合法。​
400​
InvalidNextToken.Malformed​
The specified NextToken is malformed.​
指定的 NextToken 参数格式不合法。​
400​
InvalidPaging.Malformed​
The specified PageNumber or PageSize is malformed.​
指定的分页参数格式不合法。​
404​
InvalidListener.NotFound​
The specified Listener does not exist.​
指定的监听器不存在。​
409​
InvalidOperation.Conflict​
The specified resource operation conflicts.​
指定的资源操作冲突。​
412​
IdempotentProcessing​
The request uses the same client token as a previous one that is still in process.​
幂等请求处理中。​
​
​
最近更新时间:2026.03.11 14:59:12
这个页面对您有帮助吗?
有用
有用
无用
无用