查询TCP监听配置。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
slb:DescribeLoadBalancerTCPListenerAttribute |
get |
*loadbalancer
|
|
无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
否 |
传统型负载均衡实例的地域 ID。 您可以从地域和可用区列表或通过调用 DescribeRegions 接口查询地域 ID。 |
cn-hangzhou |
| LoadBalancerId |
string |
是 |
传统型负载均衡实例 ID。 |
lb-bp1ygod3yctvg1y**** |
| ListenerPort |
integer |
是 |
传统型负载均衡实例前端使用的端口。 取值:1~65535。 |
80 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| VServerGroupId |
string |
绑定的服务器组 ID。 |
rsp-cige6******8 |
| Status |
string |
当前监听的状态。取值:
|
stopped |
| AclType |
string |
访问控制类型:
如果开启了白名单访问,但访问策略组中没有添加任何 IP,则负载均衡监听会转发全部请求。
如果开启了黑名单访问,但访问策略组中没有添加任何 IP,则负载均衡监听会转发全部请求。 说明
当 AclStatus 参数的值为 on 时,该参数必选。 |
white |
| ConnectionDrainTimeout |
integer |
设置连接优雅中断超时时间。当 ConnectionDrain 取值为 on 时,返回该值。 取值范围:10~900 秒。 |
300 |
| RequestId |
string |
请求 ID。 |
365F4154-92F6-4AE4-92F8-7FF34B540710 |
| HealthCheckConnectPort |
integer |
健康检查使用的端口。取值:1~65535。不设置此参数时,表示使用后端服务端口(BackendServerPort)。 |
8080 |
| Description |
string |
自定义监听名称。 |
TCP_80 |
| Bandwidth |
integer |
监听的带宽峰值,单位 Mbps。取值:
|
-1 |
| HealthCheckType |
string |
TCP 协议监听的健康检查方式。 取值:tcp 或 http。 |
tcp |
| MasterSlaveServerGroupId |
string |
绑定的主备服务器组 ID。 |
rsp-0bfucw**** |
| BackendServerPort |
integer |
传统型负载均衡实例后端使用的端口。 说明
当后端服务器组为虚拟服务器组时,该参数不显示。 |
443 |
| AclStatus |
string |
是否开启访问控制功能。取值:
|
off |
| HealthCheckDomain |
string |
用于健康检查的域名。取值:
|
www.domain.com |
| UnhealthyThreshold |
integer |
不健康检查阈值。健康检查连续失败多少次后,将后端服务器的健康检查状态由成功判定为失败。取值:2~10。 |
4 |
| HealthCheckHttpCode |
string |
健康检查正常的 HTTP 状态码。 |
http_2xx |
| ProxyProtocolV2Enabled |
boolean |
是否支持通过 Proxy Protocol 协议携带客户端源地址到后端服务器。取值:
|
false |
| PersistenceTimeout |
integer |
会话保持的超时时间。 取值:0~3600 秒。默认值:0,表示关闭会话保持。 |
0 |
| ListenerPort |
integer |
传统型负载均衡实例前端使用的端口。 |
110 |
| HealthCheckInterval |
integer |
健康检查的时间间隔,取值:1~50 秒。 |
5 |
| HealthCheckURI |
string |
用于健康检查的 URL。长度限制为 1~80 个字符,只能使用字母、数字和短划线(-)、正斜线(/)、半角句号(.)、百分号(%)、半角问号(?)、井号(#)和 and(&)这些字符。 URL 不能只为正斜线(/),但必须以正斜线(/)开头。 |
/test/index.html |
| AclId |
string |
监听绑定的访问策略组 ID。 当 AclStatus 参数的值为 on 时,该参数必选。 |
acl-uf60jwfi****** |
| SynProxy |
string |
是否开启负载均衡的攻击防护功能 SynProxy。 建议用户一般情况下不要调整这个参数,由负载均衡控制。
|
disable |
| Scheduler |
string |
调度算法。取值:
说明
仅性能保障型实例支持 sch 和 tch 一致性 hash 算法。 |
wrr |
| EstablishedTimeout |
integer |
连接超时时间。 |
500 |
| HealthCheckConnectTimeout |
integer |
超时时间。 |
100 |
| HealthyThreshold |
integer |
健康检查阈值。健康检查连续成功多少次后,将后端服务器的健康检查状态由失败判定为成功。取值:2~10。 |
4 |
| ConnectionDrain |
string |
是否开启连接优雅中断。当 ConnectionDrain 取值为 on 时,返回该值。取值:
|
off |
| HealthCheckMethod |
string |
健康检查方式。 |
tcp |
| HealthCheck |
string |
是否开启健康检查。取值:
|
on |
| AclIds |
object |
||
| AclId |
array |
访问控制策略组 ID 列表。 |
|
| LoadBalancerId |
string |
传统型负载均衡实例 ID。 |
lb-bp1ygod3yctvg1y**** |
| Tags |
object |
||
| Tag |
array<object> |
标签列表。 |
|
|
object |
标签列表。 |
||
| TagKey |
string |
监听的标签键。N 的取值范围:1~20。一旦传入该值,则不允许为空字符串。最多支持 128 个字符,不能以 |
TestKey |
| TagValue |
string |
监听的标签值。N 的取值范围:1~20。一旦传入该值,可以为空字符串。最多支持 128 个字符,不能以 |
TestValue |
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | LocationServiceTimeout | Location service connection timeout. Please try again later. | |
| 403 | UnauthorizedRegion | The specified region of is not authorized. | 指定地域不可见。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。