调用DescribeLoadBalancerTCPListenerAttribute查询TCP监听配置。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeLoadBalancerTCPListenerAttribute

要执行的操作。

取值:DescribeLoadBalancerTCPListenerAttribute

ListenerPort Integer 80

负载均衡实例前端使用的端口。

取值:1~65535

LoadBalancerId String lb-bp1ygod3yctvg1y****

负载均衡实例的ID。

RegionId String cn-hangzhou

负载均衡实例的地域ID。

您可以从地域和可用区列表或通过调用DescribeRegions接口查询地域ID。

返回数据

名称 类型 示例值 描述
ListenerPort Integer 110

负载均衡实例前端使用的端口。

BackendServerPort Integer 443

负载均衡实例后端使用的端口。

说明 当后端服务器组为虚拟服务器组时,该参数不显示。
Bandwidth Integer -1

监听的带宽峰值,单位Mbps。取值:

  • -1:对于按流量计费的公网负载均衡实例,可以将带宽峰值设置为-1,即不限制带宽峰值。
  • 1~5120:对于按带宽计费的公网负载均衡实例,可以设置每个监听的带宽峰值,但所有监听的带宽峰值之和不能超过实例的带宽峰值。
Status String stopped

当前监听的状态。取值:

  • running:监听正常运行中。
  • stopped:监听停止。
SynProxy String enable

是否开启负载均衡的攻击防护功能SynProxy。

建议用户一般情况下不要调整这个参数,由负载均衡控制。

  • enable:开启。
  • disable:关闭。
Scheduler String wrr

调度算法。

  • wrr(默认值):权重值越高的后端服务器,被轮询到的次数(概率)也越高。
  • rr:按照访问顺序依次将外部请求依序分发到后端服务器。
PersistenceTimeout Integer 0

会话保持的超时时间。

取值:0~3600秒。默认值:0,表示关闭会话保持。

HealthCheckType String tcp

TCP协议监听的健康检查方式。

取值:tcphttp

HealthCheck String on

是否开启健康检查。

取值:on(默认值)或off

HealthyThreshold Integer 4

健康检查阈值。健康检查连续成功多少次后,将后端服务器的健康检查状态由失败判定为成功。取值:2~10

UnhealthyThreshold Integer 4

不健康检查阈值。健康检查连续失败多少次后,将后端服务器的健康检查状态由成功判定为失败。取值:2~10

HealthCheckConnectPort Integer 8080

健康检查使用的端口。取值:1~65535。不设置此参数时,表示使用后端服务端口(BackendServerPort)。

HealthCheckInterval Integer 5

健康检查的时间间隔,取值:1~50秒。

HealthCheckDomain String www.domain.com

用于健康检查的域名。取值:

  • $_ip:后端服务器的私网IP。当指定了IP或该参数未指定时,负载均衡会使用各后端服务器的私网IP当做健康检查使用的域名。
  • domain:域名长度为1~80个字符,只能包含字母、数字、半角句号(.)和短划线(-)。
HealthCheckURI String /test/index.html

用于健康检查的URL。长度限制为1~80个字符,只能使用字母、数字和短划线(-)、正斜线(/)、半角句号(.)、百分号(%)、半角问号(?)、井号(#)和and(&)这些字符。 URL不能只为正斜线(/),但必须以正斜线(/)开头。

HealthCheckHttpCode String http_2xx

健康检查正常的HTTP状态码。

VServerGroupId String rsp-cige6******8

绑定的服务器组ID。

AclId String 12

监听绑定的访问策略组ID。

AclStatus参数的值为on时,该参数必选。

AclStatus String off

是否开启访问控制功能。

取值:onoff(默认值)。

AclType String white

访问控制类型:

  • white: 仅转发来自所选访问控制策略组中设置的IP地址或地址段的请求,白名单适用于应用只允许特定IP访问的场景。

    设置白名单存在一定业务风险。一旦设置白名单,就只有白名单中的IP可以访问负载均衡监听。

    如果开启了白名单访问,但访问策略组中没有添加任何IP,则负载均衡监听不会转发请求。

  • black: 来自所选访问控制策略组中设置的IP地址或地址段的所有请求都不会转发,黑名单适用于应用只限制某些特定IP访问的场景。

    如果开启了黑名单访问,但访问策略组中没有添加任何IP,则负载均衡监听会转发全部请求。

AclStatus参数的值为on时,该参数必选。

ConnectionDrain String off

是否开启连接优雅中断。当ConnectionDrain取值为on时,返回该值。

取值:

  • on:开启
  • off:未开启
ConnectionDrainTimeout Integer 300

设置连接优雅中断超时时间。当ConnectionDrain取值为on时,返回该值。

取值范围:10~900秒。

Description String TCP监听

监听描述。

EstablishedTimeout Integer 500

连接超时时间。

HealthCheckConnectTimeout Integer 100

超时时间。

HealthCheckMethod String tcp

健康检查方式。

MasterSlaveServerGroupId String rsp-0bfucw****

绑定的主备服务器组ID。

RequestId String 365F4154-92F6-4AE4-92F8-7FF34B540710

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeLoadBalancerTCPListenerAttribute
&ListenerPort=80
&LoadBalancerId=lb-bp1ygod3yctvg1y****
&<公共请求参数>

正常返回示例

XML格式

<?xml version="1.0" encoding="UTF-8"?>
<DescribeLoadBalancerTCPListenerAttributeResponse>
rGroupId>rsp-cige6******8</VServerGroupId>
<Description>TCP监听</Description>
<SynProxy>enable</SynProxy>
<UnhealthyThreshold>4</UnhealthyThreshold>
<HealthCheckURI>/test/index.html</HealthCheckURI>
<Scheduler>wrr</Scheduler>
<HealthCheck>on</HealthCheck>
<BackendServerPort>443</BackendServerPort>
<PersistenceTimeout>0</PersistenceTimeout>
<HealthCheckConnectPort>8080</HealthCheckConnectPort>
<HealthCheckMethod>tcp</HealthCheckMethod>
<Bandwidth>-1</Bandwidth>
<HealthCheckHttpCode>http_2xx</HealthCheckHttpCode>
<EstablishedTimeout>500</EstablishedTimeout>
<Status>stopped</Status>
<ListenerPort>110</ListenerPort>
<HealthCheckInterval>5</HealthCheckInterval>
<RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
<AclId>12</AclId>
<HealthCheckConnectTimeout>100</HealthCheckConnectTimeout>
<AclStatus>off</AclStatus>
<HealthyThreshold>4</HealthyThreshold>
<MasterSlaveServerGroupId>rsp-0bfucw*****</MasterSlaveServerGroupId>
<HealthCheckDomain>www.domain.com</HealthCheckDomain>
<AclType>white</AclType>
<HealthCheckType>tcp</HealthCheckType>
</DescribeLoadBalancerTCPListenerAttributeResponse>

JSON格式

{"VServerGroupId":"rsp-cige6******8",
"Description":"TCP监听",
"SynProxy":"enable",
"UnhealthyThreshold":"4",
"HealthCheckURI":"/test/index.html",
"Scheduler":"wrr",
"HealthCheck":"on",
"BackendServerPort":"443",
"PersistenceTimeout":"0",
"HealthCheckConnectPort":"8080",
"HealthCheckMethod":"tcp",
"Bandwidth":"-1",
"HealthCheckHttpCode":"http_2xx",
"EstablishedTimeout":"500",
"Status":"stopped",
"ListenerPort":"110",
"HealthCheckInterval":"5",
"RequestId":"365F4154-92F6-4AE4-92F8-7FF34B540710",
"AclId":"12",
"HealthCheckConnectTimeout":"100",
"AclStatus":"off",
"HealthyThreshold":"4",
"MasterSlaveServerGroupId":"rsp-0bfucw*****",
"HealthCheckDomain":"www.domain.com",
"AclType":"white",
"HealthCheckType":"tcp"}

错误码

访问错误中心查看更多错误码。