调用DescribeLoadBalancerTCPListenerAttribute接口查询TCP监听配置。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
RegionId String cn-hangzhou

传统型负载均衡实例的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

Action String DescribeLoadBalancerTCPListenerAttribute

系统规定参数。取值:DescribeLoadBalancerTCPListenerAttribute

LoadBalancerId String lb-bp1ygod3yctvg1y****

传统型负载均衡实例的ID。

ListenerPort Integer 80

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

取值范围:1~65535

返回数据

名称 类型 示例值 描述
VServerGroupId String rsp-cige6******8

绑定的服务器组ID。

Status String running

当前监听的状态。取值:

  • running:监听正常运行中。
  • stopped:监听停止。
AclType String white

访问控制类型。取值:

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

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

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

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

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

ConnectionDrainTimeout Integer 200

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

取值范围:10~900

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

请求ID。

HealthCheckConnectPort Integer 8080

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

Description String tcp_80

自定义监听名称。

长度限制为1~256个字符,支持中文、字母、数字、短划线(-)、正斜线(/)、半角句号(.)和下划线(_)。

Bandwidth Integer -1

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

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

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

取值:tcphttp

MasterSlaveServerGroupId String rsp-0bfucw****

绑定的主备服务器组ID。

BackendServerPort Integer 443

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

说明VServerGroupIdMasterSlaveServerGroupId均为空时,此参数有效。
AclStatus String off

是否开启访问控制功能。取值:

  • on:开启。
  • off:未开启。
HealthCheckDomain String domain

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

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

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

HealthCheckHttpCode String http_2xx

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

取值:http_2xxhttp_3xxhttp_4xxhttp_5xx

ProxyProtocolV2Enabled Boolean false

是否支持通过Proxy Protocol协议携带客户端源地址到后端服务器。取值:

  • true:是。
  • false:否。
PersistenceTimeout Integer 0

会话保持的超时时间。单位:秒。

取值范围:0~36000表示关闭会话保持。

ListenerPort Integer 110

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

HealthCheckInterval Integer 5

健康检查的时间间隔。单位:秒。取值范围:1~50

HealthCheckURI String /test/index.html

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

AclId String 12

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

SynProxy String enable

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

  • enable:开启
  • disable:未开启
Scheduler String wrr

调度算法。取值:

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

连接超时时间。单位:秒。

HealthCheckConnectTimeout Integer 100

超时时间。单位:秒。

HealthyThreshold Integer 4

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

ConnectionDrain String off

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

  • on:开启
  • off:未开启
HealthCheckMethod String tcp

健康检查方式。

HealthCheck String on

是否开启健康检查。取值:

  • on:开启
  • off:未开启

示例

请求示例

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

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeLoadBalancerTCPListenerAttributeResponse>
    <VServerGroupId>rsp-cige6******8</VServerGroupId>
    <Status>running</Status>
    <AclType>white</AclType>
    <ConnectionDrainTimeout>200</ConnectionDrainTimeout>
    <RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
    <HealthCheckConnectPort>8080</HealthCheckConnectPort>
    <Description>tcp_80</Description>
    <Bandwidth>-1</Bandwidth>
    <HealthCheckType>tcp</HealthCheckType>
    <MasterSlaveServerGroupId>rsp-0bfucw****</MasterSlaveServerGroupId>
    <BackendServerPort>443</BackendServerPort>
    <AclStatus>off</AclStatus>
    <HealthCheckDomain>domain</HealthCheckDomain>
    <UnhealthyThreshold>4</UnhealthyThreshold>
    <HealthCheckHttpCode>http_2xx</HealthCheckHttpCode>
    <ProxyProtocolV2Enabled>false</ProxyProtocolV2Enabled>
    <PersistenceTimeout>0</PersistenceTimeout>
    <ListenerPort>110</ListenerPort>
    <HealthCheckInterval>5</HealthCheckInterval>
    <HealthCheckURI>/test/index.html</HealthCheckURI>
    <AclId>12</AclId>
    <SynProxy>enable</SynProxy>
    <Scheduler>wrr</Scheduler>
    <EstablishedTimeout>500</EstablishedTimeout>
    <HealthCheckConnectTimeout>100</HealthCheckConnectTimeout>
    <HealthyThreshold>4</HealthyThreshold>
    <ConnectionDrain>off</ConnectionDrain>
    <HealthCheckMethod>tcp</HealthCheckMethod>
    <HealthCheck>on</HealthCheck>
</DescribeLoadBalancerTCPListenerAttributeResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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