DescribeLoadBalancerTCPListenerAttribute查询TCP监听配置-边缘节点服务 ENS-阿里云-边缘节点服务 ENS(ENS)-阿里云帮助中心

调用DescribeLoadBalancerTCPListenerAttribute查询TCP监听配置。

接口说明

API 调用频率：100 次/秒。
单用户调用频率：10 次/秒。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ens:DescribeLoadBalancerTCPListenerAttribute

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
ListenerPort	integer	是	需要查询的监听端口。取值：1~65535。	80
LoadBalancerId	string	是	负载均衡实例的 ID。	lb-5snthcyu1x10g7tywj7iu****

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
ListenerPort	integer	负载均衡实例前端使用的端口。	80
Status	string	当前监听的状态。取值： Running：正常运行。 Stopped：运行停止。 Starting：启动中。 Configuring：配置中。 Stopping：运行停止中。	Stopped
Bandwidth	integer	负载均衡带宽峰值，默认值为-1（表示不限速）。	-1
Scheduler	string	调度算法。取值： wrr：权重值越高的后端服务器，被轮询到的次数（概率）也越高。 wlc：除了根据每台后端服务器设定的权重值来进行轮询，同时还考虑后端服务器的实际负载（即连接数）。当权重值相同时，当前连接数越小的后端服务器被轮询到的次数（概率）也越高。 rr：按照访问顺序依次将外部请求依序分发到后端服务器。 sch：基于源 IP 地址的一致性 hash，相同的源地址会调度到相同的后端服务器。 tch：基于四元组的一致性 hash（源 IP+目的 IP+源端口+目的端口），相同的流会调度到相同的后端服务器。	wrr
PersistenceTimeout	integer	会话保持的超时时间。默认值：0，表示关闭会话保持。取值：0~3600。单位：秒。	0
EstablishedTimeout	integer	连接超时时间，取值：10~900，单位：秒。	500
HealthCheck	string	是否开启健康检查。取值： on：开启。 off：关闭。	on
HealthyThreshold	integer	健康检查连续成功多少次后，将后端服务器的健康检查状态由 fail（后台服务器不可达）判定为 success（后台服务器可达）。取值：2~10。说明 HealthCheck 值为 on 时才会有效。	4
UnhealthyThreshold	integer	健康检查连续失败多少次后，将后端服务器的健康检查状态由 success（后台服务器可达）判定为 fail（后台服务器不可达）。取值：2~10。说明 HealthCheck 值为 on 时才会有效。	4
HealthCheckConnectTimeout	integer	接收来自运行状况检查的响应需要等待的时间。如果后端 ENS 在指定的时间内没有响应，则判定为健康检查失败。默认值：5 秒。取值：1~300。单位：秒。说明 HealthCheck 值为 on 时才会有效。如果 HealthCheckConnectTimeout 的值小于 HealthCheckInterval 的值，则 HealthCheckConnectTimeout 无效，超时时间为 HealthCheckInterval 的值。	100
HealthCheckInterval	integer	健康检查的时间间隔。取值：1~50，单位：秒。	5
Description	string	监听名称。	example
HealthCheckHttpCode	string	健康检查正常时的 HTTP 状态码。取值： http_2xx（默认值）。 http_3xx。 http_4xx。 http_5xx。说明 HealthCheck 值为 on 时才会有效。	http_2xx
HealthCheckDomain	string	用于健康检查的域名。说明 HealthCheck 值为 on 时才会有效。	example.com
HealthCheckURI	string	用于健康检查的 URI。长度限制为 1~80。说明 URL 不能只有`/`，但必须以`/`开头。 HealthCheck 值为 on 时才会有效。	/example/index.html
HealthCheckType	string	健康检查类型。取值： tcp（默认值）。 http。	tcp
BackendServerPort	integer	负载均衡实例后端服务器使用的端口，取值：1~65535。	8080
HealthCheckConnectPort	integer	健康检查使用的端口，取值：1~65535。不设置此参数时，表示使用后端服务端口（BackendServerPort）。说明 HealthCheck 值为 on 时才会有效。	8000
EipTransmit	string	是否开启 EIP 透传，取值： on：开启。 off（默认值）：关闭。	on

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "ListenerPort": 80,
  "Status": "Stopped",
  "Bandwidth": -1,
  "Scheduler": "wrr",
  "PersistenceTimeout": 0,
  "EstablishedTimeout": 500,
  "HealthCheck": "on",
  "HealthyThreshold": 4,
  "UnhealthyThreshold": 4,
  "HealthCheckConnectTimeout": 100,
  "HealthCheckInterval": 5,
  "Description": "example",
  "HealthCheckHttpCode": "http_2xx",
  "HealthCheckDomain": "example.com",
  "HealthCheckURI": "/example/index.html",
  "HealthCheckType": "tcp",
  "BackendServerPort": 8080,
  "HealthCheckConnectPort": 8000,
  "EipTransmit": "on"
}

错误码

HTTP status code	错误码	错误信息	描述
400	ens.interface.error	An error occurred while call the API.
400	LoadBalancerNotFound	The input parameter loadBalancerId that is not found.
400	ListenerNotFound	Listener is not found.	监听不存在
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

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

变更历史

更多信息，参考变更详情。