调用CreateLoadBalancerTCPListener创建TCP监听。
接口说明
- API 调用频率:100 次/秒。
- 单用户调用频率:10 次/秒。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ens:CreateLoadBalancerTCPListener | create | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
LoadBalancerId | string | 是 | 负载均衡实例的 ID。 | lb-5ovkn1piwqmoqrfjdyhq4**** |
ListenerPort | integer | 是 | 负载均衡对外提供服务,接收请求并向后端服务器进行请求转发的监听端口。取值:1~65535。 | 80 |
Description | string | 否 | 设置监听名称。长度限制为 1~80 个字符。 说明
不能以 http:// 和https:// 开头。
| example |
Scheduler | string | 否 | 调度算法。取值:
| wrr |
PersistenceTimeout | integer | 否 | 会话保持的超时时间。
| 0 |
EstablishedTimeout | integer | 否 | 连接超时时间,取值:10~900,默认值为 900,单位:秒。 | 500 |
HealthyThreshold | integer | 否 | 健康检查连续成功多少次后,将后端服务器的健康检查状态由 fail(后台服务器不可达)判定为 success(后台服务器可达)。取值:2~10,默认值为 3。 | 4 |
UnhealthyThreshold | integer | 否 | 健康检查连续失败多少次后,将后端服务器的健康检查状态由 success(后台服务器可达)判定为 fail(后台服务器不可达)。取值:2~10,默认值为 3。 | 4 |
HealthCheckConnectTimeout | integer | 否 | 接收来自运行状况检查的响应需要等待的时间。如果后端 ENS 在指定的时间内没有响应,则判定为健康检查失败。
说明
如果 HealthCheckConnectTimeout 的值小于 HealthCheckInterval 的值,则 HealthCheckConnectTimeout 无效,超时时间为 HealthCheckInterval 的值。
| 100 |
HealthCheckInterval | integer | 否 | 健康检查的时间间隔。取值:1~50,默认值为 2,单位:秒。 | 3 |
HealthCheckDomain | string | 否 | 用于健康检查的域名。 | www.aliyundoc.com |
HealthCheckURI | string | 否 | 用于健康检查的 URI。长度限制为 1~80。 说明
URL 不能只有 / ,但必须以/ 开头。
| /checkpreload.htm |
HealthCheckHttpCode | string | 否 | 健康检查正常时的 HTTP 状态码。取值:
| http_2xx |
HealthCheckType | string | 否 | 健康检查类型。取值:
| tcp |
BackendServerPort | integer | 否 | 负载均衡实例后端服务器使用的端口,取值:1~65535。 | 8080 |
HealthCheckConnectPort | integer | 否 | 健康检查使用的端口,取值:1~65535。不设置此参数时,表示使用后端服务端口(BackendServerPort)。 | 8080 |
EipTransmit | string | 否 | 是否开启 EIP 透传,取值:
| on |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "06F00FBB-3D9E-4CCE-9D43-1A6946A75456"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Invalid%s | The specified parameter %s is invalid. | 参数不正确 |
400 | Missing%s | You must specify the parameter %s. | 参数为必填 |
400 | LoadBalancerNotFound | The input parameter loadBalancerId that is not found. | 负载均衡实例不存在 |
400 | IncorrectInstanceStatus | The current status of the resource does not support this operation. | 当前操作不被支持,磁盘正在重置中。 |
400 | ListenerAlreadyExists | The listener already exists. | 该监听已存在。 |
400 | ens.interface.error | Failed to call API. | 接口调用发生异常。 |
400 | NoPermission | Permission denied. | 没有足够的权限,请联系云账号管理员授予您相应权限。 |
400 | InvalidParameter.%s | The specified field %s invalid. Please check it again. | - |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-07-04 | OpenAPI 错误码发生变更 | 查看变更详情 |