ListenerId

String

是

lsn-2fek3rgsxhrsw5oxruwec****

监听器ID。
您可以调用DescribeListeners接口，查询监听器ID。

ListenerName

String

否

mylistener

监听器的名称。

• 必须以字母、数字或中文开头，可包含字母、数字、中文及以下特殊字符：点号（.）、下划线（_）和中划线（-）。
• 长度限制在1 ～ 128字符之间。

Description

String

否

This is a listener.

监听器的描述。

• 必须以字母、数字或中文开头，可包含字母、数字、中文及以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）。
• 长度限制为0 ～ 255个字符。

Scheduler

Sting

否

wrr

监听器使用的调度算法。取值如下：

• wrr （默认值）：加权轮询，权重值越高的后端服务器，被轮询到的次数（概率）越高。
• wlc：加权最小连接数，在最少连接数的基础上，根据服务器的不同处理能力，给每个服务器分配不同的权重，使其能够接受相应权值数的服务请求。
• sh：源地址哈希，基于源IP地址的一致性哈希，相同的源地址会调度到相同的后端服务器。

Bandwidth

Integer

否

10

监听器的带宽峰值，单位为Mbps。

• 设置为-1，表示监听器不指定限速。此时监听器的带宽峰值默认为CLB实例规格的剩余带宽。
• 监听器带宽峰值最大不能超过所属CLB实例的规格带宽，CLB实例的规格带宽请参见产品规格。

ServerGroupId

String

否

rsp-bp1o94dp5i6ea****

监听器关联的后端服务组ID。

• 对于HTTP/HTTPS监听器，此参数代表关联的默认后端服务器组ID。
  您可以调用DescribeServerGroups接口，查询后端服务器组ID。
• 2021年8月30日后，七层监听器上线默认后端服务器组功能，编辑存量七层监听器时，此参数为必选，否则将无法修改监听器的其他属性。

CertificateSource

String

否

clb

证书的来源。

• clb ：CLB侧证书管理模块
• cert_center：证书中心。

CertificateId

String

否

cert-bp1o94dp5i6ea****

CLB侧证书管理模块的证书的ID。
您可以调用DescribeCertificates接口，查询证书ID。

HealthCheck.Enabled

String

否

on

监听器是否开启健康检查功能。

• on：开启。
• off：不开启。

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个字符。

HealthCheck.UdpExpect

String

否

Expect123

健康检查的预期响应字符串。
只允许包含字母和数字，最大长度限制为64个字符。

HealthCheck.Method

String

否

HEAD

监听器健康检查的方法。取值有以下几种：

• GET（默认值）：服务器需支持GET方法。
• HEAD：服务器仅返回HEAD头部信息，可以降低后端开销，但要求服务器支持HEAD方法。

HealthCheck.Domain

String

否

www.test.com

健康检查的域名，需配置为后端服务器上真实对外提供服务的地址。

• 需至少包含一个点号（.），且不允许以点号（.）开头或结尾。
• 单个字符串由字母、数字、中划线（-）、点号（.）字符组成，中划线（-）不得出现在字符串的头部或尾部。
• 长度限制为1 ～ 128个字符。
• 不传入该参数或该参数不传入数值时，默认为空，表示负载均衡使用各后端服务器的私网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

Integer

否

80

健康检查的后端服务器端口，取值范围为1-65535。
仅开启全端口监听且开启健康检查时，此参数有效。 全端口监听功能正在邀测中，暂仅支持完成 企业认证 的账号申请试用，如需试用，请联系客户经理。

EstablishedTimeout

Integer

否

800

监听器的连接超时时间。
仅协议Protocol为TCP或UDP时，本参数有效。取值如下：

• TCP协议：10-900秒。
• UDP协议：1-300秒。

ClientHeaderTimeout

Integer

否

60

读取客户端请求头的超时时间。客户端向CLB发起请求，若在超时时间内客户端没有传输整个报头，CLB将返回408错误码给客户端，表示请求超时。

• 取值范围为30-120秒。

• 仅协议Protocol为HTTP或HTTPS时，本参数有效。

ClientBodyTimeout

Integer

否

60

读取客户端请求正文的超时时间。客户端向CLB发起请求，若在超时时间内客户端没有发送任何请求体，CLB将返回408错误码给客户端，表示请求超时。

• 此超时时间仅针对两个连续的读操作之间设置，而非整个请求的传输过程。

• 取值范围为 30-120秒。

• 仅协议Protocol为HTTP或HTTPS时，本参数有效。

KeepaliveTimeout

Integer

否

60

客户端与CLB之间的长连接超时时间。若在超时时间内一直没有访问请求，CLB会中断当前连接，直到下一次请求到来时重新建立新的连接。

• 取值范围为 0-900秒。

• 0表示禁用长连接。

• 仅协议Protocol为HTTP或HTTPS时，本参数有效。

ProxyConnectTimeout

Integer

否

60

CLB与后端服务器之间的连接建立超时时间。若超时时间内CLB与后端服务器连接未建立，则终止建立连接操作。

• 建议大于健康检查超时时间。

• 取值范围为 4-120秒。

• 仅协议Protocol为HTTP或HTTPS时，本参数有效。

ProxySendTimeout

Integer

否

60

CLB将请求传输到后端服务器的超时时间。CLB向后端服务器发起请求，若后端服务器在超时时间内未收到任何内容，则会关闭此连接。

• 此超时仅针对两个连续的写操作之间设置，而非整个请求的传输过程。

• 取值范围为30-3600秒。

• 仅协议Protocol为HTTP或HTTPS时，本参数有效。

ProxyReadTimeout

Integer

否

60

CLB从后端服务器读取响应的超时时间。CLB向后端服务器发起请求，若超时时间内接收请求的后端服务器无响应，则会关闭此连接。

• 此超时时间仅针对两个连续的读操作之间设置，而非整个响应的传输过程。

• 取值范围为30-3600秒。

• 仅协议Protocol为HTTP或HTTPS时，本参数有效。

SendTimeout

Integer

否

60

CLB向客户端发送响应的超时时间。CLB向客户端发送响应，若客户端在超时时间内未收到任何内容，则连接会被关闭。

• 此超时仅针对两个连续的写操作之间设置，而非整响应的传输过程。

• 取值范围为 1-3600秒。

• 仅协议Protocol为HTTP或HTTPS时，本参数有效。

SecurityPolicyId

String

否

default_policy

监听器的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。

• 除default_policy外，以上TLS安全策略支持的加密套件详情请参见创建HTTPS协议监听器。

• 传入default_policy时，按照ECDH+AESGCM:DH+AESGCM:ECDH+AES256:DH+AES256:ECDH+AES128:DH+AES:ECDH+3DES:DH+3DES:RSA+AESGCM:RSA+AES:RSA+3DES:!aNULL:!MD5配置生效。

AclStatus

String

否

off

是否开启访问控制功能。取值如下：

• on：开启。
• off：不开启。

AclType

String

否

black

访问控制的方式。取值如下:

• white：白名单。监听器监听CLB的流量时，CLB仅转发其白名单关联访问控制策略组中IP地址的请求。
• black：黑名单。监听器监听CLB的流量时，对于白名单关联访问控制策略组中IP地址的请求，CLB拒绝转发。

AclIds.N

String

否

AclIds.1=acl-3cj44nv0jhhxc6c6rrtet****&AclIds.2=acl-2febxt4pu0zy85oxruw0t****

监听器绑定的访问控制策略组ID。
您可以调用DescribeAcls接口，查询访问控制策略组ID。

• 参数 - N：表示访问控制策略组的序号，取值范围：1～5。
• 多个访问控制策略组ID间使用“&”分隔。

ProxyProtocolType

String

否

off

是否启用Proxy-Protocol协议。
仅协议Protocol为TCP或UDP时，本参数有效。取值如下：

• off：关闭。
• standard：开启。

PersistenceType

String

否

off

会话保持的类型。取值如下：

• off：表示不启用会话保持。
• source_ip：表示源地址IP，仅对TCP/UDP协议生效。
• insert：表示植入Cookie，仅对HTTP/HTTPS协议且Scheduler为“wrr”时生效。
• server：表示重写Cookie，仅对HTTP/HTTPS协议且Scheduler为“wrr”时生效。

PersistenceTimeout

Integer

否

10

会话保持的超时时间。单位为秒，取值范围根据参数PersistenceType取值有所不同。

• PersistenceType配置为source_ip时，取值范围为1～3600。
• PersistenceType配置为insert时，取值范围为1～86400。

Cookie

String

否

cookie123

后端服务器配置的会话保持的Cookie名称。

• 只能包含字母、数字、下划线（_）和中划线（-）。
• 长度限制在1～200字符之间。

Http2Enabled

String

否

off

监听器是否开启前端HTTP 2.0协议。
仅协议Protocol为HTTPS时，本参数有效。取值如下

• on：开启。
• off：不开启。

ConnectionDrainEnabled

String

否

on

监听器是否开启连接优雅中断功能。
仅协议Protocol为TCP或UDP时，本参数有效。取值如下

• on：开启。请继续配置超时时间ConnectionDrainTimeout。
• off：不开启。

ConnectionDrainTimeout

Integer

否

2

连接优雅中断的超时时间。

• 仅参数ConnectionDrainEnabled为on时，本参数有效。
• 取值范围：0～900，单位为秒。

Enabled

String

否

off

是否启用监听器。取值如下：

• on：开启。
• off：不开启。

403

Forbidden

You are not authorized to perform operations on the specified service; for example, the 'Bandwidth'.

无权限对指定服务进行操作，比如 Bandwidth。