文档

CreateLoadBalancerTCPListener - 创建TCP监听

调用CreateLoadBalancerTCPListener创建TCP监听。

接口说明

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

调试

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

授权信息

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

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

请求参数

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

负载均衡实例的 ID。

lb-5ovkn1piwqmoqrfjdyhq4****
ListenerPortinteger

负载均衡实例前端使用的端口。取值:1~65535

80
Descriptionstring

设置监听的描述信息。长度限制为 1~80 个字符。

说明 不能以http://https://开头。
example
Schedulerstring

调度算法。取值:

  • wrr(默认值):权重值越高的后端服务器,被轮询到的次数(概率)也越高。
  • wlc:除了根据每台后端服务器设定的权重值来进行轮询,同时还考虑后端服务器的实际负载(即连接数)。当权重值相同时,当前连接数越小的后端服务器被轮询到的次数(概率)也越高。
  • rr:按照访问顺序依次将外部请求依序分发到后端服务器。
  • sch:基于源 IP 地址的一致性 Hash,相同的源地址会调度到相同的后端服务器。
  • qch:基于 QUIC Connection ID 一致性 Hash,相同的 QUIC Connection ID 会调度到相同的后端服务器。
  • iqch:针对 iQUIC CID 的特定三个字节进行一致 Hash,第 2~第 4 三个字节相同的会调度到相同的后端服务器。
wrr
PersistenceTimeoutinteger

会话保持的超时时间。

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

连接超时时间,取值:10~900,默认值为 900,单位:秒。

500
HealthyThresholdinteger

健康检查连续成功多少次后,将后端服务器的健康检查状态由 fail(后台服务器不可达)判定为 success(后台服务器可达)。取值:2~10,默认值为 3

4
UnhealthyThresholdinteger

健康检查连续失败多少次后,将后端服务器的健康检查状态由 success(后台服务器可达)判定为 fail(后台服务器不可达)。取值:2~10,默认值为 3

4
HealthCheckConnectTimeoutinteger

接收来自运行状况检查的响应需要等待的时间。如果后端 ECS 在指定的时间内没有响应,则判定为健康检查失败。

  • 默认值:5 秒。
  • 取值:1~300
  • 单位:秒。
说明 如果 HealthCheckConnectTimeout 的值小于 HealthCheckInterval 的值,则 HealthCheckConnectTimeout 无效,超时时间为 HealthCheckInterval 的值。
100
HealthCheckIntervalinteger

健康检查的时间间隔。取值:1~50,默认值为 2,单位:秒。

3
HealthCheckDomainstring

用于健康检查的域名。

www.aliyundoc.com
HealthCheckURIstring

用于健康检查的 URI。长度限制为 1~80

说明 URL 不能只有/,但必须以/开头。
/checkpreload.htm
HealthCheckHttpCodestring

健康检查正常时的 HTTP 状态码。取值:

  • http_2xx(默认值)。
  • http_3xx
  • http_4xx
  • http_5xx
http_2xx
HealthCheckTypestring

健康检查类型。取值:

  • tcp(默认值)。
  • http
tcp
BackendServerPortinteger

负载均衡实例后端使用的端口,取值:1~65535

8080
HealthCheckConnectPortinteger

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

8080
EipTransmitstring

是否开启 EIP 透传,取值:

  • on:开启。
  • off(默认值):关闭。
on

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

06F00FBB-3D9E-4CCE-9D43-1A6946A75456

示例

正常返回示例

JSON格式

{
  "RequestId": "06F00FBB-3D9E-4CCE-9D43-1A6946A75456"
}

错误码

HTTP status code错误码错误信息描述
400ens.interface.errorAn error occurred while call the API.-
400Invalid%sThe specified parameter %s is invalid.参数不正确
400Missing%sYou must specify the parameter %s.参数为必填
400LoadBalancerNotFoundThe input parameter loadBalancerId that is not found.-
400IncorrectInstanceStatusThe current status of the resource does not support this operation.当前操作不被支持,磁盘正在重置中。
400ListenerAlreadyExistsThe listenerPort already exists.-
400NoPermissionPermission denied.没有足够的权限,请联系云账号管理员授予您相应权限。
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈