负载均衡
负载均衡
传统型负载均衡CLB
请输入
- 文档首页
负载均衡API参考CLB-监听器CreateListener - 创建监听器
复制全文
下载 pdfCreateListener - 创建监听器
文档反馈
问问助手调用 CreateListener 接口，为指定CLB实例添加一个监听器。
使用说明
- 创建UDP监听器时，监听端口未被其他UDP监听器监听。
- 创建TCP/HTTP/HTTPS监听器时，监听端口未被其他TCP/HTTP/HTTPS监听器监听。
- CLB实例有未被独占的带宽。若无，请调整已有监听器独占的带宽或者提升CLB实例的规格。
- 四层监听器（TCP和UDP协议）支持将请求转发至IPv4或IPv6的后端服务器。
- 七层监听器（HTTP和HTTPS协议）仅支持将请求转发至IPv4后端服务器。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action String 必选 示例值：CreateListener
要执行的操作，取值：CreateListener。
Version String 必选 示例值：2020-04-01
API的版本信息，当前版本为 2020-04-01。
LoadBalancerId String 必选 示例值：clb-bp1o94dp5i6ea****
CLB实例的ID。
ListenerName String 可选 示例值：mylistener
监听器的名称。
- 必须以字母、数字或中文开头，可包含字母、数字、中文及以下特殊字符：点号（.）、下划线（_）和中划线（-）。
- 长度限制在1～128字符之间。
- 不填则默认将“协议-端口”作为监听器名称。
Description String 可选 示例值：This is a listener.
监听器的描述。
- 必须以字母、数字或中文开头，可包含字母、数字、中文及以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）。
- 长度限制为0 ～ 255个字符。
- 不填则默认值为空字符串。
Protocol String 必选 示例值：TCP
监听器的协议。取值如下：
- TCP
- UDP
- HTTP
- HTTPS
Port Integer 必选 示例值：80
监听器接收请求使用的端口。取值范围为 0～65535。
参数Protocol为“TCP”或“UDP”时，支持传入0，表示启用全端口监听。
说明
四层监听器的全端口监听功能正在邀测中，暂仅支持完成企业认证的账号申请试用，如需试用，请联系客户经理。
StartPort Integer 可选 示例值：80
全端口监听的起始端口，取值范围为1-65535。
参数Port为“0”时，该参数必须传入。
EndPort Integer 可选 示例值：100
全端口监听的结束端口，取值范围为1-65535。
参数Port为“0”时，该参数必须传入，且该参数取值应大于StartPort。
Scheduler String 可选 示例值：wrr
监听器使用的调度算法。取值如下：
- wrr（默认值）：加权轮询。即权重值越高的后端服务器，被轮询到的次数（概率）越高。
- wlc：加权最小连接数。即在最少连接数的基础上，根据服务器的不同处理能力，给每个服务器分配不同的权重，使其能够接受相应权值数的服务请求。
- sh：源地址哈希。即基于源IP地址的一致性哈希，相同的源地址会调度到相同的后端服务器。
Cps Integer 可选 示例值：-1
每秒新建连接数的上限。
- -1（默认值）：不限制，即CLB实例的新建连接数上限。
- 取值范围：1～CLB实例的新建连接数上限。
- CLB的实例规格请参见产品规格。
说明
此功能正在邀测中，如需试用，请联系客户经理。
MaxConnections Integer 可选 示例值：-1
最大并发连接数的上限。
- -1（默认值）：不限制，CLB实例的最大并发连接数上限。
- 取值范围：1～CLB实例的最大并发连接数上限。CLB的实例规格请参见产品规格。
说明
此功能正在邀测中，如需试用，请联系客户经理。
Bandwidth Integer 可选 示例值：10
监听器的带宽上限，即此监听器独占CLB实例的带宽，单位为Mbps。
- -1（默认值）：此监听器不独占CLB的带宽，与其他监听器共享CLB实例未被独占的带宽。
- 取值范围：1～CLB实例未被独占的带宽。 CLB实例的规格带宽请参见产品规格。
ServerGroupId String 必选 示例值：rsp-bp1o94dp5i6ea****
监听器关联的后端服务器组 ID。
CertificateSource String 可选 示例值：clb
证书的来源。
- clb (默认)：CLB上传的证书
- cert_center：证书中心上传的证书。
CertCenterCertificateId String 可选 示例值：cert-bp1o94dp5i6eb****
证书中心上传证书的ID。
CAEnabled String 可选 示例值：off
是否开启双向认证。
- on：开启。
- off（默认值）：不开启。
CACertificateId String 可选 示例值：pca_leaf_M6gaihuZRcO****
双向认证的CA证书的ID。
HealthCheck.Enabled String 可选 示例值：on
监听器是否开启健康检查功能。
- on（默认值）：开启。
- off：不开启。
说明
仅当本参数的值为 on 时，参数HealthCheck.****有效。
HealthCheck.Interval Integer 可选 示例值：2
执行健康检查的时间间隔，取值范围为1 ～ 300 ，默认值为2，单位为秒。
HealthCheck.Timeout Integer 可选 示例值：2
健康检查的响应超时时间，表示如果后端服务器在指定的时间内没有正确响应，则判定为健康检查“异常”。
取值范围为1 ～ 60，默认值为2，单位为秒。
说明
响应超时时间需小于等于检查时间间隔。
HealthCheck.HealthyThreshold Integer 可选 示例值：3
健康检查的健康阈值，表示连续执行指定次数的健康检查，结果均为“正常”的后端服务器将被判定为健康检查“正常”。
取值范围为2 ～ 10，默认值为3，单位为次。
HealthCheck.UnhealthyThreshold Integer 可选 示例值：3
健康检查的不健康阈值，表示连续执行指定次数的健康检查，结果均为“异常”的后端服务器将被判定为健康检查异常。
取值范围为2 ～ 10，默认值为3，单位为次。
HealthCheck.UdpRequest String 可选 示例值：Request123
健康检查的请求字符串。
- 只允许包含字母和数字，最大长度限制为64个字符。
- 当参数Protocol配置为UDP，且参数HealthCheck.Enabled配置为on时，该参数生效。
- 参数HealthCheck.UdpRequest和HealthCheck.UdpExpect的取值只能同时为空或同时不为空。
HealthCheck.UdpExpect String 可选 示例值：Expect123
健康检查的预期响应字符串。
- 只允许包含字母和数字，最大长度限制为64个字符。
- 当参数Protocol配置为UDP，且参数HealthCheck.Enabled配置为on时，该参数生效。
- 参数HealthCheck.UdpRequest和HealthCheck.UdpExpect的取值只能同时为空或同时不为空。
HealthCheck.Method String 可选 示例值：HEAD
监听器健康检查的方法。
当参数Protocol取HTTP或HTTPS，且HealthCheck.Enabled取on时，本参数生效。取值如下：
- GET（默认值）：服务器需支持GET方法。
- HEAD：服务器仅返回HEAD头部信息，可以降低后端开销，但要求服务器支持HEAD方法。
HealthCheck.Domain String 可选 示例值：www.test.com
健康检查的域名，需配置为后端服务器上真实对外提供服务的地址。
- 当参数Protocol取HTTP或HTTPS，且HealthCheck.Enabled取on时，本参数生效。
- 需至少包含一个点号（.），且不允许以点号（.）开头或结尾。
- 单个字符串由字母、数字、中划线（-）、点号（.）字符组成，中划线（-）不得出现在字符串的头部或尾部。
- 长度限制为1 ～ 128个字符。
- 不传入该参数或该参数不传入数值时，默认为空，表示CLB使用各后端服务器的私网IP地址进行健康检查。
HealthCheck.URI String 可选 示例值：/test
健康检查的路径，需配置为后端服务器上真实对外提供服务的地址。
- 当参数Protocol取HTTP或HTTPS，且HealthCheck.Enabled取on时，本参数生效。
- 必须以字符‘/’开头。
- 仅包含字母、数字、中划线（-）、下划线（_）、斜线（/）、点号（.）、百分号（%）、英文问号（?）、#、&、等号（＝）字符。
- 长度限制为1 ～ 128个字符。
- 不传入该参数或该参数不传入数值时，默认为“/”。
HealthCheck.HttpCode String 可选 示例值：http_2xx,http_3xx
健康检查正常的HTTP状态码。
当参数Protocol取HTTP或HTTPS，且HealthCheck.Enabled取on时，本参数生效。取值如下：
- http_2xx （默认值）
- http_3xx
- http_4xx
- http_5xx
多个状态码间用半角逗号“,”分隔。
HealthCheck.Port String 可选 示例值：80
健康检查的端口，取值范围为1-65535。
EstablishedTimeout Integer 可选 示例值：800
监听器的连接超时时间。
仅参数Protocol取TCP或UDP时，本参数有效。取值如下：
- TCP协议：10-900秒，默认为900秒。
- UDP协议：1-300秒，默认为90秒。
ClientHeaderTimeout Integer 可选 示例值：60
读取客户端请求头的超时时间。客户端向CLB发起请求，若在超时时间内客户端没有传输整个报头，CLB将返回408错误码给客户端，表示请求超时。
- 取值范围为30-120秒。默认为60秒。
- 仅参数Protocol取HTTP或HTTPS时，本参数有效。
ClientBodyTimeout Integer 可选 示例值：60
读取客户端请求正文的超时时间。客户端向CLB发起请求，若在超时时间内客户端没有发送任何请求体，CLB将返回408错误码给客户端，表示请求超时。
- 此超时时间仅针对两个连续的读操作之间设置，而非整个请求的传输过程。
- 取值范围为 30-120秒，默认为60秒。
- 仅参数Protocol取HTTP或HTTPS时，本参数有效
KeepaliveTimeout Integer 可选 示例值：60
客户端与CLB之间的长连接超时时间。若在超时时间内一直没有访问请求，CLB会中断当前连接，直到下一次请求到来时重新建立新的连接。
- 取值范围为 0-900秒，默认为75秒。
- 0表示禁用长连接。
- 仅参数Protocol取HTTP或HTTPS时，本参数有效。
ProxyConnectTimeout Integer 可选 示例值：60
CLB与后端服务器之间的连接建立超时时间。若超时时间内CLB与后端服务器连接未建立，则终止建立连接操作。
- 建议大于健康检查超时时间。
- 取值范围为 4-120秒，默认为4秒。
- 仅参数Protocol取HTTP或HTTPS时，本参数有效。
ProxySendTimeout Integer 可选 示例值：60
CLB将请求传输到后端服务器的超时时间。CLB向后端服务器发起请求，若后端服务器在超时时间内未收到任何内容，则会关闭此连接。
- 此超时仅针对两个连续的写操作之间设置，而非整个请求的传输过程。
- 取值范围为30-3600秒，默认为60秒。
- 仅参数Protocol取HTTP或HTTPS时，本参数有效。
ProxyReadTimeout Integer 可选 示例值：60
CLB从后端服务器读取响应的超时时间。CLB向后端服务器发起请求，若超时时间内接收请求的后端服务器无响应，则会关闭此连接。
- 此超时时间仅针对两个连续的读操作之间设置，而非整个响应的传输过程。
- 取值范围为30-3600秒，默认为60秒。
- 仅参数Protocol取HTTP或HTTPS时，本参数有效。
SendTimeout Integer 可选 示例值：60
CLB向客户端发送响应的超时时间。CLB向客户端发送响应，若客户端在超时时间内未收到任何内容，则连接会被关闭。
- 此超时仅针对两个连续的写操作之间设置，而非整响应的传输过程。
- 取值范围为 1-3600秒，默认为60秒。
- 仅参数Protocol取HTTP或HTTPS时，本参数有效。
SecurityPolicyId String 可选 示例值：default_policy
HTTPS监听器的TLS安全策略。
- 仅参数Protocol取HTTPS时，本参数有效。 取值如下：
- default_policy（默认值）：支持SSL v3、TLS v1.0、TLS v1.1、TLS v1.2。
- tls_cipher_policy_1_0：支持TLS v1.0、TLS v1.1、TLS v1.2。
- tls_cipher_policy_1_1：支持TLS v1.1、TLS v1.2。
- tls_cipher_policy_1_2：支持TLS v1.2。
- tls_cipher_policy_1_2_strict：支持TLS v1.2。
- tls_cipher_policy_1_3：支持TLS v1.3。
- tls_cipher_policy_1_2_strict_with_1_3：支持TLS v1.2、TLS v1.3。
说明
- 以上TLS安全策略支持的加密套件详情请参见创建HTTPS协议监听器。
- 不填则默认按照ECDH+AESGCM:DH+AESGCM:ECDH+AES256:DH+AES256:ECDH+AES128:DH+AES:ECDH+3DES:DH+3DES:RSA+AESGCM:RSA+AES:RSA+3DES:!aNULL:!MD5配置生效。
- 安全策略tls_cipher_policy_1_3、、tls_cipher_policy_1_2_strict_with_1_3正在邀测中，如需试用，请联系客户经理。
AclStatus String 可选 示例值：off
是否开启访问控制功能。取值如下：
- on：开启。
- off（默认值）：不开启。
AclType String 可选 示例值：black
访问控制的方式。取值如下:
- white：白名单。监听器监听CLB的流量时，CLB仅转发其白名单关联访问控制策略组中IP地址的请求。
- black（默认值）：黑名单。监听器监听CLB的流量时，对于白名单关联访问控制策略组中IP地址的请求，CLB拒绝转发。
说明
当参数AclStatus取 on 时，AclType和AclIds.N为必填。
AclIds.N String 可选 示例值：cl-3cj44nv0jhhxc6c6rrtet****
监听器绑定的访问控制策略组ID。
- 参数 - N：表示访问控制策略组的序号，数量上限为5个。
- 多个访问控制策略组ID间使用“&”分隔。
说明
当参数AclStatus取 on 时，AclType和AclIds.N为必填。
ProxyProtocolType String 可选 示例值：off
是否启用Proxy-Protocol协议。
仅参数Protocol取TCP或UDP时，本参数有效。取值如下：
- off（默认值）：关闭。
- standard：开启。
PersistenceType String 可选 示例值：off
会话保持的类型。取值如下：
- off（默认值）：不启用会话保持。
- source_ip：源地址IP，仅参数Protocol取TCP或UDP时，本取值有效。
- insert：植入Cookie，仅参数Protocol取HTTP或HTTPS且Scheduler取wrr时，本取值生效。
- server：重写Cookie，仅参数Protocol取HTTP或HTTPS且Scheduler取wrr时，本取值生效。。
PersistenceTimeout Integer 可选 示例值：10
会话保持的超时时间。单位为秒。默认值为1000秒，取值范围根据参数PersistenceType取值有所不同。
- PersistenceType配置为source_ip时，取值范围为1～3600。
- PersistenceType配置为insert时，取值范围为1～86400。
说明
参数PersistenceType配置为source_ip或insert时，本参数有效。
Cookie String 可选 示例值：cookie123
后端服务器配置的会话保持的Cookie名称。
- 仅参数PersistenceType取server时，本参数有效且必填。
- 只能包含字母、数字、下划线（_）和中划线（-）。
- 长度限制在1～200字符之间。
Http2Enabled String 可选 示例值：off
监听器是否开启前端HTTP 2.0协议。
仅参数`Protocol取HTTPS时，本参数有效。取值如下：|
- on：开启。
- off（默认值）：不开启。
ConnectionDrainEnabled String 可选 示例值：on
监听器是否开启连接优雅中断功能。
仅参数Protocol取TCP或UDP时，本参数有效。取值如下：
- on：开启。
- off（默认值）：不开启。
ConnectionDrainTimeout Integer 可选 示例值：2
连接优雅中断的超时时间。取值范围为0～900，单位为秒。
- 参数ConnectionDrainEnabled取on时，本参数为必填。
- 参数ConnectionDrainEnabled取off时，本参数默认为0。
Enabled String 可选 示例值：on
是否启用监听器。取值如下:
- on（默认值）：开启。
- off：不开启。
Tags.N.Key String 可选 示例值：key1
用户标签的标签键。
- 参数 - N：表示标签键的序号，取值范围：1～20。
- 多个标签键之间用&分隔。
- 不能以 volc:或sys:开头，包括任意大小写形式。
- 长度取值范围为1~128字符，允许输入各国语言文字、数字、空格（ ）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、中划线（-）和@（@）。
- 若标签键开头或结尾存在空格，系统会自动为其去除。
说明
同一资源的标签键不允许重复。
Tags.N.Value String 可选 示例值：value1
用户标签的标签值。
- 参数 - N：表示标签值的序号，取值范围：1～20。
- 多个标签值之间用&分隔。
- 长度取值范围为0～256字符，不填默认为空。
- 允许输入各国语言文字、数字、空格（ ）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、中划线（-）和@（@）。
- 大小写敏感。
- 若标签值开头或结尾存在空格，系统会自动为其去除。
说明
若传入该参数，则必须先传入Tags.N.Key。
返回参数
RequestId String 示例值：20210811152539010225146063030****
请求ID。
ListenerId String 示例值：lsn-2fek3rgsxhrsw5oxruwec****
监听器ID。
请求示例
返回示例
错误码
最近更新时间：2026.09.18 11:25:02
这个页面对您有帮助吗？
有用
有用
无用
无用