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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 CreateListener

系统规定参数。取值：CreateListener。
ListenerProtocol String 是 TCP

监听协议。取值：TCP、UDP或TCPSSL。
ListenerPort Integer 是 80

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

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

自定义监听名称。

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

网络型负载均衡实例ID。
ServerGroupId String 是 sgp-ppdpc14gdm3x4o****

服务器组ID。
IdleTimeout Integer 否 900

连接空闲超时时间。单位：秒。

取值范围：1~900。默认值：900。
SecurityPolicyId String 否 tls_cipher_policy_1_0

安全策略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监听生效。
CertificateIds.N String 否 12315790212_166f8204689_1714763408_70998****

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

说明 目前仅支持添加1个服务器证书。
CaCertificateIds.N String 否 139a00604ad-cn-east-hangzh****

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

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

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

  • true：启动。
  • false（默认值）：关闭。
DryRun Boolean 否 false

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

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

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

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

说明 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。
RegionId String 否 cn-hangzhou

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

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

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

  • true：开启。
  • false（默认值）：关闭。
SecSensorEnabled Boolean 否 false

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

  • true：开启。
  • false（默认值）：关闭。
AlpnEnabled Boolean 否 false

是否开启ALPN。取值：

  • true：开启。
  • false（默认值）：关闭。
AlpnPolicy String 否 HTTP1Only

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开启后需配置该参数。
StartPort Integer 否 244

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

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

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

终止端口的取值大于起始端口。

说明 当ListenerPort为0时，需要配置该参数。
Cps Integer 否 100

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

TCP报文的最大段大小。单位：字节，取值范围：0~1500。

0：表示不修改用户TCP报文的MSS值。

说明 仅TCP、TCPSSL类型的监听支持该字段值。

返回数据

名称 类型 示例值 描述
RequestId String CEF72CEB-54B6-4AE8-B225-F876FF7BA984

请求ID。
ListenerId String lsn-bp1bpn0kn908w4nbw****

监听ID。
JobId String 72dcd26b-f12d-4c27-b3af-18f6aed5****

异步任务ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateListener
&ListenerProtocol=TCP
&ListenerPort=80
&ListenerDescription=tcp_80
&LoadBalancerId=nlb-83ckzc8d4xlp8o****
&ServerGroupId=sgp-ppdpc14gdm3x4o****
&IdleTimeout=900
&SecurityPolicyId=tls_cipher_policy_1_0
&CertificateIds=["12315790212_166f8204689_1714763408_70998****"]
&CaCertificateIds=["139a00604ad-cn-east-hangzh****"]
&CaEnabled=false
&DryRun=false
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&RegionId=cn-hangzhou
&ProxyProtocolEnabled=false
&SecSensorEnabled=false
&AlpnEnabled=false
&AlpnPolicy=HTTP1Only
&StartPort=244
&EndPort=566
&Cps=100
&Mss=43
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateListenerResponse>
    <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
    <ListenerId>lsn-bp1bpn0kn908w4nbw****</ListenerId>
    <JobId>72dcd26b-f12d-4c27-b3af-18f6aed5****</JobId>
</CreateListenerResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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