文档

DescribeLoadBalancerTCPListenerAttribute - 查询TCP监听配置

更新时间:

查询TCP监听配置。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
slb:DescribeLoadBalancerTCPListenerAttributeRead
  • loadbalancer
    acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}
  • slb:tag

请求参数

名称类型必填描述示例值
RegionIdstring

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

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

cn-hangzhou
LoadBalancerIdstring

传统型负载均衡实例 ID。

lb-bp1ygod3yctvg1y****
ListenerPortinteger

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

取值:1~65535

80

返回参数

名称类型描述示例值
object
VServerGroupIdstring

绑定的服务器组 ID。

rsp-cige6******8
Statusstring

当前监听的状态。取值:

  • running:监听正常运行中。

  • stopped:监听停止。

stopped
AclTypestring

访问控制类型:

  • white: 仅转发来自所选访问控制策略组中设置的 IP 地址或地址段的请求,白名单适用于应用只允许特定 IP 访问的场景。 设置白名单存在一定业务风险。一旦设置白名单,就只有白名单中的 IP 可以访问负载均衡监听。

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

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

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

说明 AclStatus 参数的值为 on 时,该参数必选。
white
ConnectionDrainTimeoutinteger

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

取值范围:10~900 秒。

300
RequestIdstring

请求 ID。

365F4154-92F6-4AE4-92F8-7FF34B540710
HealthCheckConnectPortinteger

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

8080
Descriptionstring

自定义监听名称。

TCP_80
Bandwidthinteger

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

  • -1:对于按流量计费的公网负载均衡实例,可以将带宽峰值设置为-1,即不限制带宽峰值。

  • 1~5120:对于按带宽计费的公网负载均衡实例,可以设置每个监听的带宽峰值,但所有监听的带宽峰值之和不能超过实例的带宽峰值。

-1
HealthCheckTypestring

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

取值:tcphttp

tcp
MasterSlaveServerGroupIdstring

绑定的主备服务器组 ID。

rsp-0bfucw****
BackendServerPortinteger

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

说明 当后端服务器组为虚拟服务器组时,该参数不显示。
443
AclStatusstring

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

  • on:开启。
  • off:不开启。
off
HealthCheckDomainstring

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

  • $_ip:后端服务器的私网 IP。当指定了 IP 或该参数未指定时,负载均衡会使用各后端服务器的私网 IP 当做健康检查使用的域名。

  • domain:域名长度为 1~80 个字符,只能包含字母、数字、半角句号(.)和短划线(-)。

www.domain.com
UnhealthyThresholdinteger

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

4
HealthCheckHttpCodestring

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

http_2xx
ProxyProtocolV2Enabledboolean

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

  • true:是。
  • false:否。
false
PersistenceTimeoutinteger

会话保持的超时时间。

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

0
ListenerPortinteger

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

110
HealthCheckIntervalinteger

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

5
HealthCheckURIstring

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

/test/index.html
AclIdstring

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

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

acl-uf60jwfi******
SynProxystring

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

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

  • enable:开启。

  • disable:关闭。

disable
Schedulerstring

调度算法。取值:

  • wrr(默认值):权重值越高的后端服务器,被轮询到的次数(概率)也越高。

  • rr:按照访问顺序依次将外部请求依序分发到后端服务器。

  • sch:基于源 IP 地址的一致性 hash,相同的源地址会调度到相同的后端服务器。

  • tch:基于四元组的一致性 hash(源 IP+目的 IP+源端口+目的端口),相同的流会调度到相同的后端服务器。

说明 仅性能保障型实例支持 schtch 一致性 hash 算法。
wrr
EstablishedTimeoutinteger

连接超时时间。

500
HealthCheckConnectTimeoutinteger

超时时间。

100
HealthyThresholdinteger

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

4
ConnectionDrainstring

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

  • on:开启。

  • off:未开启。

off
HealthCheckMethodstring

健康检查方式。

tcp
HealthCheckstring

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

  • on:开启。
  • off:关闭。
on
AclIdsarray

访问控制策略组 ID 列表。

LoadBalancerIdstring

传统型负载均衡实例 ID。

lb-bp1ygod3yctvg1y****
Tagsobject []

标签列表。

TagKeystring

监听的标签键。N 的取值范围:1~20。一旦传入该值,则不允许为空字符串。最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://https://

TestKey
TagValuestring

监听的标签值。N 的取值范围:1~20。一旦传入该值,可以为空字符串。最多支持 128 个字符,不能以acs:开头,不能包含http://或者https://

TestValue

示例

正常返回示例

JSON格式

{
  "VServerGroupId": "rsp-cige6******8",
  "Status": "stopped",
  "AclType": "white",
  "ConnectionDrainTimeout": 300,
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "HealthCheckConnectPort": 8080,
  "Description": "TCP_80",
  "Bandwidth": -1,
  "HealthCheckType": "tcp",
  "MasterSlaveServerGroupId": "rsp-0bfucw****",
  "BackendServerPort": 443,
  "AclStatus": "off",
  "HealthCheckDomain": "www.domain.com",
  "UnhealthyThreshold": 4,
  "HealthCheckHttpCode": "http_2xx",
  "ProxyProtocolV2Enabled": false,
  "PersistenceTimeout": 0,
  "ListenerPort": 110,
  "HealthCheckInterval": 5,
  "HealthCheckURI": "/test/index.html",
  "AclId": "acl-uf60jwfi******",
  "SynProxy": "disable",
  "Scheduler": "wrr",
  "EstablishedTimeout": 500,
  "HealthCheckConnectTimeout": 100,
  "HealthyThreshold": 4,
  "ConnectionDrain": "off",
  "HealthCheckMethod": "tcp",
  "HealthCheck": "on",
  "AclIds": {
    "AclId": [
      ""
    ]
  },
  "LoadBalancerId": "lb-bp1ygod3yctvg1y****",
  "Tags": {
    "Tag": [
      {
        "TagKey": "TestKey",
        "TagValue": "TestValue"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400LocationServiceTimeoutLocation service connection timeout. Please try again later.Location服务连接超时,请稍后重试。

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

变更历史

变更时间变更内容概要操作
2024-05-28OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2023-09-08OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    新增错误码:400