Skip to Content
网路负载均衡 NLB描述监听器 - DescribeNLBListeners

描述监听器 - DescribeNLBListeners

简介

描述监听器

定义

公共参数

参数名类型描述信息必填
Actionstring对应的 API 指令名称，当前 API 为 DescribeNLBListenersYes
PublicKeystring用户公钥，可从 控制台  获取Yes
Signaturestring根据公钥及 API 指令生成的用户签名，参见 签名算法Yes

请求参数

参数名类型描述信息必填
Regionstring地域。 参见 地域和可用区列表Yes
ProjectIdstring项目ID。不填写为默认项目，子帐号必须填写。 请参考GetProjectList接口No
NLBIdstring负载均衡实例的ID。未指定 ListenerId ，则描述指定的 LoadBalancerId 下的所有监听器Yes
ListenerIdstring监听器的IDNo
Limitint限制返回的监听器数量No
Offsetint设置监听器的偏移量No

响应字段

字段名类型描述信息必填
RetCodeint返回状态码，为 0 则为成功返回，非 0 为失败Yes
Actionstring操作指令名称Yes
Messagestring返回错误消息，当 RetCode 非 0 时提供详细的描述信息No
TotalCountint全部个数Yes
Listenersarray[Listener]返回的监听器列表Yes

数据模型

Listener

字段名类型描述信息必填
ListenerIdstring监听器的IDNo
Namestring监听器的名称No
Remarkstring监听器的备注信息No
StartPortint端口范围的起始端口No
EndPortint端口范围的结束端口No
Protocolstring监听协议，限定取值：“TCP”/“UDP”No
Schedulerstring负载均衡算法，限定取值：“RoundRobin”/“SourceHash”/“LeastConn”/“WeightLeastConn ”/“WeightRoundRobin “No
StickinessTimeoutint会话保持超时时间。单位：秒，0表示不开启会话保持No
ForwardSrcIPMethodstring传递源 IP 方法。限定取值："" / “None” / “Toa”/“ProxyProto”，空字符串和 None 代表关闭。No
HealthCheckConfigHealthCheckConfig健康检查相关配置No
Targetsarray[Target]服务节点信息No
Statestringlistener 健康状态，“Healthy”/“Unhealthy”/“PartialHealth”/“None”No
DeletionProtectionboolean是否开启删除保护No

HealthCheckConfig

字段名类型描述信息必填
Enabledboolean是否开启健康检查功能。No
Portint健康检查探测端口
说明：
限定取值：[1-65535]		No
Typestring健康检查方式
限定取值：“Port”/“UDP”/“Ping” /“HTTP”
默认值：“Port”		No
Intervalint健康检查间隔时间
限定取值：[1-60] 单位秒
默认 2s		No
MinSuccessint健康检查最小成功数
限定取值：[1-10]
默认 3		No
MaxFailint健康检查最大失败数
限定取值：[1-10]
默认 3		No
ReqMsgstringUDP” 检查模式的请求字符串
”HTTP” 检查模式的请求 json 字符串		No
ResMsgstring”UDP” 检查模式的预期响应字符串
”HTTP” 检查模式的响应状态码		No

Target

字段名类型描述信息必填
Regionstring服务节点所在地域No
ResourceTypestring服务节点的类型No
ResourceIdstring服务节点的资源ID。在非IP类型时，必传No
ResourceNamestring服务节点的资源名称No
VPCIdstring服务节点的VPC资源ID。在IP类型时，必传No
SubnetIdstring服务节点的子网资源ID。在IP类型时，必传No
ResourceIPstring服务节点的IP。在IP类型时，必传No
Portint服务节点的端口No
Weightint服务节点的权重。支持更新No
Enabledboolean服务节点是否开启No
Idstring服务节点的标识 ID
说明：
添加服务节点的时候无需传
更新服务节点属性时必传		No
Statestring服务节点的健康检查状态
说明：
描述服务节点信息时显示
限定枚举值：“Healthy”/“Unhealthy”		No

示例

请求示例

https://api.tnqacloud.com/?Action=DescribeNLBListeners
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=zTqiQROM
&NLBId=OxYTDxqj
&ListenerId=htQOHAjL
&Limit=6
&Offset=vXMpaXtW

响应示例

{
  "Action": "DescribeNLBListenersResponse",
  "Listeners": [
    {
      "EndPort": 3,
      "HealthCheckConfig": {},
      "IdleTimeout": 1,
      "ListenerId": "rkBmVaIv",
      "Name": "zEwDggfG",
      "Protocol": "eFyjvUkt",
      "Remark": "jNzTwrej",
      "Scheduler": "LLIVlwrh",
      "StartPort": 8,
      "State": "lPggUqwU",
      "StickinessTimeout": 1,
      "Targets": [
        {
          "Id": "WsMDEgKl",
          "Port": 1,
          "ResourceIP": "mNwgTlSs",
          "ResourceId": "yXhLvcOl",
          "ResourceName": "GZrvlkxA",
          "ResourceType": "PrqlPfMT",
          "State": "UVUgJQac",
          "SubnetId": "uopkZCvB",
          "VPCId": "hALclZIH",
          "Weight": 9
        }
      ]
    }
  ],
  "RetCode": 0,
  "TotalCount": 4
}
删除负载均衡实例 - DeleteNetworkLoadBalancer描述负载均衡实例 - DescribeNetworkLoadBalancers