备案控制台
文档
产品文档
输入文档关键字查找
首页 负载均衡 网络型负载均衡NLB 开发参考 API参考 API目录 监听 CreateListener - 创建监听

CreateListener - 创建监听

更新时间：
一键部署
产品详情
相关技术圈
我的收藏

在网络型负载均衡实例中创建TCP、UDP或TCPSSL监听。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
ListenerProtocolstring是

监听协议。取值：TCP、UDP 或 TCPSSL。

TCP
ListenerPortinteger是

监听端口。取值范围：0~65535。

0：表示使用全端口功能。当设置为 0 时，您需要配置 StartPort 和 EndPort。

80
ListenerDescriptionstring否

自定义监听名称。

长度限制为 2~256 个字符，支持中文和英文字母，可包含数字、半角逗号（,）、半角句号（.）、半角分号（;）、正斜线（/）、at（@）、下划线（_）和短划线（-）。

tcp_80
LoadBalancerIdstring是

网络型负载均衡实例 ID。

nlb-83ckzc8d4xlp8o****
ServerGroupIdstring是

服务器组 ID。

sgp-ppdpc14gdm3x4o****
IdleTimeoutinteger否

连接空闲超时时间。单位：秒。 取值范围：1~900。默认值：900。

900
SecurityPolicyIdstring否

安全策略 ID。支持系统安全策略和自定义安全策略。

  • 系统策略取值：tls_cipher_policy_1_0（默认值）、tls_cipher_policy_1_1、tls_cipher_policy_1_2、tls_cipher_policy_1_2_strict或tls_cipher_policy_1_2_strict_with_1_3。
  • 自定义安全策略：输入自定义安全策略 ID。
说明 仅对 TCPSSL 监听生效。
tls_cipher_policy_1_0
CertificateIdsarray否

服务器证书列表信息。仅对 TCPSSL 监听生效。

说明 目前仅支持添加 1 个服务器证书。
string否

服务器证书列表信息。仅对 TCPSSL 监听生效。

说明 目前仅支持添加 1 个服务器证书。
123157******
CaCertificateIdsarray否

CA 证书列表。仅对 TCPSSL 监听生效。

说明 目前仅支持添加 1 个 CA 证书。
string否

CA 证书列表。仅对 TCPSSL 监听生效。

说明 目前仅支持添加 1 个 CA 证书。
139a00******
CaEnabledboolean否

是否启动双向认证。取值：

  • true：启动。

  • false（默认值）：关闭。

false
DryRunboolean否

是否只预检此次请求。取值：

  • true：发送检查请求，不会创建监听。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。
  • false（默认值）：发送正常请求，通过检查后返回 HTTP 2xx 状态码并直接进行操作。
false
ClientTokenstring否

客户端 Token，用于保证请求的幂等性。

从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
123e4567-e89b-12d3-a456-426655440000
RegionIdstring否

网络型负载均衡实例所在的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou
ProxyProtocolEnabledboolean否

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

  • true：开启。

  • false（默认值）：关闭。

false
SecSensorEnabledboolean否

是否开启秒级监控功能。取值：

  • true：开启。

  • false（默认值）：关闭。

false
AlpnEnabledboolean否

是否开启 ALPN。取值：

  • true：开启。

  • false（默认值）：关闭。

false
AlpnPolicystring否

ALPN 策略。取值：

  • HTTP1Only：只协商使用 HTTP1.x 协议，优先级为 HTTP1.1>HTTP1.0。
  • HTTP2Only：只协商使用 HTTP2.0 协议。
  • HTTP2Optional：优先使用 HTTP1.x 协议，但也接受 HTTP2.0 协议，优先级为 HTTP1.1>HTTP1.0>HTTP2.0。
  • HTTP2Preferred：优先使用 HTTP2.0 协议，但也接受 HTTP1.x 协议，优先级为 HTTP2.0>HTTP1.1>HTTP1.0。
说明 AlpnEnabled 开启后需配置该参数。
HTTP1Only
StartPortinteger否

全端口监听起始端口。取值范围：0 ~ 65535。

说明 当 ListenerPort 为 0 时，需要配置该参数。
244
EndPortinteger否

全端口监听结束端口。取值范围：0 ~ 65535。 终止端口的取值大于起始端口。

说明 当 ListenerPort 为 0 时，需要配置该参数。
566
Cpsinteger否

网络型负载均衡实例每秒新建连接限速值。取值范围：0~1000000。0 表示不限速。

100
Mssinteger否

TCP 报文的最大段大小。单位：字节，取值范围：0~1500。 0：表示不修改用户 TCP 报文的 MSS 值。

说明 仅 TCP、TCPSSL 类型的监听支持该字段值。
43
Tagobject []否

标签列表。

Keystring否

标签键。最多支持 64 个字符，不能以aliyun或acs:开头，不能包含http://或https://。支持字符包括字母、数字、下划线 (_)、点 (.)、冒号 (:)、斜线 (/)、等号 (=)、加号 (+)、减号 (-)、@符号 (@) 。

一次调用最多支持添加 20 个标签。

KeyTest
Valuestring否

标签值。最多支持 128 个字符，不能以aliyun或acs:开头，不能包含http://或https://。支持字符包括字母、数字、下划线 (_)、点 (.)、冒号 (:)、斜线 (/)、等号 (=)、加号 (+)、减号 (-)、@符号 (@) 。

一次调用最多支持添加 20 个标签。

Test
ProxyProtocolV2Configobject否

通过 Proxy Protocol 协议携带 VpcId、PrivateLinkEpId、PrivateLinkEpsId 信息到后端服务器配置。

Ppv2VpcIdEnabledboolean否

是否开启通过 Proxy Protocol 协议携带 VpcId 到后端服务器。取值：

  • true：开启。

  • false（默认值）：关闭。

false
Ppv2PrivateLinkEpIdEnabledboolean否

是否开启通过 Proxy Protocol 协议携带 Ppv2PrivateLinkEpId 到后端服务器。取值：

  • true：开启。

  • false（默认值）：关闭。

false
Ppv2PrivateLinkEpsIdEnabledboolean否

是否开启通过 Proxy Protocol 协议携带 PrivateLinkEpsId 到后端服务器。取值：

  • true：开启。

  • false（默认值）：关闭。

false

返回参数

名称类型描述示例值
object

RpcResponse

RequestIdstring

请求 ID。

CEF72CEB-54B6-4AE8-B225-F876FF7BA984
ListenerIdstring

监听 ID。

lsn-bp1bpn0kn908w4nbw****
JobIdstring

异步任务 ID。

72dcd26b-f12d-4c27-b3af-18f6aed5****

示例

正常返回示例

JSON格式

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "ListenerId": "lsn-bp1bpn0kn908w4nbw****",
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}

错误码

HTTP status code错误码错误信息描述
400Conflict.PortThe Port [%s] is conflict.指定端口与已有端口存在冲突
400IllegalParam.MssConflictWithUdpAndGeneveThe param of MssConflictWithUdpAndGeneve is illegal.Mss值不为null时，listenerProtocol不可以是udp或者GENEVE。
400QuotaExceeded.%sThe quota of %s is exceeded, usage %s/%s.%s的配额超过限制，已使用%s/%s
400SystemBusySystem is busy, please try again later.系统繁忙，请稍后重试
400Mismatch.VpcIdThe VpcId is mismatched for %s and %s.资源%s和资源%s的VpcId不匹配。请检查两种资源是否在同一个VPC下。
400ResourceNotEnough.%sThe specified resource of %s is not enough.所需要的资源%s不足了
400Conflict.LockThe Lock [%s] is conflict.指定的资源当前存在锁冲突。
400IllegalParam.AnyPortListenerConflictWithNonAnyPortServerGroupThe param of AnyPortListenerConflictWithNonAnyPortServerGroup is illegal.servergroup的全端口转发开关，必须匹配与监听的anyport开关匹配，请检查参数。
400IncorrectStatus.loadbalancerThe status of loadbalancer [%s] is incorrect.负载均衡的状态无法进行当前操作，请检查负载均衡当前是否处于其他操作下。
400ResourceNotFound.CertificateThe specified resource %s is not found.资源%s不存在。
400IllegalParam.ServerGroupIdThe param of ServerGroupId is illegal.参数ServerGroupId非法，请检查输入参数。
400IllegalParam.NonAnyPortListenerConflictWithAnyPortServerGroupThe param of NonAnyPortListenerConflictWithAnyPortServerGroup is illegal.监听端口配置与全端口转发开关冲突。
400MissingParam.CertificateThe param of certificate is missing.参数Certificate缺失。
400IllegalParam.PortThe param of Port is illegal.请求中的端口范围非法，请检查输入参数。
400QuotaExceeded.QuotaInsufficientThe quota of %s is exceeded, usage %s/%s.配额不足，已使用%s/%s。请在配额中心中修改配额大小。
400Mismatch.ProtocolThe Protocol is mismatched for %s and %s.监听和服务器组的协议不匹配。
400ResourceNotEnough.CaCertificateApiCountThe specified resource of CaCertificateApiCount is not enough.触发证书服务限流，请稍后重试。
400MissingParam.ServerGroupIdThe param of ServerGroupId is missing.参数ServerGroupId缺失，请检查输入参数。
400IllegalParam.ListenerDescriptionThe parameter ListenerDescription of listener is illegal.监听描述不符合输入要求，请根据错误中的详细信息进行修改。
400DryRunOperationRequest validation has been passed with DryRun flag set.dryRun请求验证已通过。
400IllegalParam.IdleTimeoutThe param of IdleTimeout is illegal.参数连接空闲超时时间配置非法。
400MissingParam.%sThe parameter of %s is missing.参数%s缺失，请检查输入参数。
400IllegalParamThe param of %s is illegal.输入的参数有值非法，请检查输入。
400IllegalParamSize.certificateIdsThe param size of certificateIds or caCertificateIds is illegal.证书的id只能有一个，请检查是否重复输入。
400DuplicatedParam.listenerThe param of any port listener is duplicated.只能创建一个anyport类型监听，请检查输入参数。
400IllegalParam.PreserveClientIpSwitchThe server group associated with the tcpssl listener does not support enabling PreserveClientIp.tcpssl监听关联的服务器组不支持开启客户端ip保持功能
403Forbidden.NoPermissionAuthentication is failed for NoPermission.因为账号没有权限，所以鉴权失败。
404ResourceNotFound.VSwitchThe specified resource of vSwitch is not found.找不到指定的虚拟交换机资源，请检查输入参数。
404ResourceNotFound.loadBalancerThe specified resource of loadbalancer is not found.找不到指定的负载均衡器资源，请检查输入参数。
404ResourceNotFound.serverGroupThe specified resource of serverGroup is not found.找不到指定的服务器组资源，请检查输入参数。
404ResourceNotFound.CaCertificateThe specified resource of CaCertificate is not found.Ca证书不存在，请检查输入参数。

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

变更历史

变更时间变更内容概要操作
2024-03-14OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    错误码 400 变更
    删除错误码：403
    删除错误码：404
2024-02-22OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    错误码 404 变更
    删除错误码：400
    删除错误码：403
2024-02-04OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    错误码 400 变更
    删除错误码：403
    删除错误码：404
2024-01-30OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    删除错误码：400
    删除错误码：403
    删除错误码：404
2024-01-29OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    错误码 403 变更
    删除错误码：400
    删除错误码：404
2024-01-24OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    错误码 400 变更
    删除错误码：403
    删除错误码：404
2024-01-22OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    错误码 400 变更
    错误码 404 变更
    删除错误码：403
2023-12-20OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    错误码 400 变更
    删除错误码：403
    删除错误码：404
2023-12-18OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    错误码 400 变更
    删除错误码：403
    删除错误码：404
2023-11-27OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    错误码 400 变更
    删除错误码：403
    删除错误码：404
入参OpenAPI 入参发生变更。
    新增入参：ProxyProtocolV2Config
2023-10-10OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    错误码 400 变更
    删除错误码：403
    删除错误码：404
2023-10-09OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    错误码 400 变更
    删除错误码：403
    删除错误码：404
2023-09-26OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    错误码 400 变更
    错误码 403 变更
    删除错误码：404
2023-09-12OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    错误码 404 变更
    删除错误码：400
    删除错误码：403
2023-09-05OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    错误码 400 变更
    删除错误码：403
    新增错误码：404
2023-08-22OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    新增错误码：400
    新增错误码：403
2023-06-30API 内部配置变更，不影响调用看变更集
变更项变更内容
API 内部配置变更，不影响调用。
2023-06-29OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更。
    新增入参：Tag
2023-03-30API 内部配置变更，不影响调用看变更集
变更项变更内容
API 内部配置变更，不影响调用。
文档推荐
  • 本页导读 （1）
文档反馈