接口约束
4.10 监听器
4.10.3 更新监听器
功能介绍
更新监听器。
接口约束
如果listener关联的load balancer的provisioning 状态不是ACTIVE，则不能更新该 listener。
只有管理员用户才能指定connection_limit的值。
调试
您可以在API Explorer中调试该接口。
URI
PUT /v3/{project_id}/elb/listeners/{listener_id}
表4-238 路径参数
参数 是否必选 参数类型 描述
listener_id 是 String 监听器ID。
project_id 是 String 租户ID。
请求参数
表4-239 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String IAM鉴权Token。
表4-240 请求 Body 参数
参数 是否必选 参数类型 描述
listener 是 UpdateListen erOption object
监听器对象。
表4-241 UpdateListenerOption
ontainer_ref 否 String 监听器使用的CA证书ID。仅客 户端证书有效，其他类型证书无
ntainer_ref 否 String 监听器使用的服务器证书ID。
使用说明：
description 否 String 监听器的描述信息。
最小长度：0 最大长度：255
http2_enable 否 Boolean 客户端与LB之间的HTTPS请求 的HTTP2功能的开启状态。开启
s 否 ListenerInser
tHeaders
参数 是否必选 参数类型 描述
name 否 String 监听器的名称。
最小长度：0 最大长度：255 sni_container_
refs 否 Array of
strings 监听器使用的SNI证书（带域名 的服务器证书）ID列表。
使用说明：
● 列表对应的所有SNI证书的域 名不允许存在重复。
● 列表对应的所有SNI证书的域 名总数不超过30。
● QUIC监听器仅支持RSA证 书。
tls_ciphers_po
licy 否 String 监听器使用的安全策略，仅对
HTTPS协议类型的监听器有效。
取值：tls-1-0-inherit, tls-1-0, tls-1-1, tls-1-2, tls-1-2-strict，
tls-1-2-fs, tls-1-0-with-1-3, tls-1-2-fs-with-1-3, hybrid-policy-1-0。
使用说明：
● 若同时设置了 security_policy_id和 tls_ciphers_policy，则仅 security_policy_id生效。
security_polic
y_id 否 String 自定义安全策略的ID。仅对
HTTPS协议类型的监听器且关联 LB为独享型时有效。 使用说 明：
● 若同时设置了 security_policy_id和 tls_ciphers_policy，则仅 security_policy_id生效。
最小长度：1 最大长度：36
参数 是否必选 参数类型 描述 enable_memb
er_retry 否 Boolean 是否开启后端服务器的重试。取 值：true 开启重试，false 不开 启重试。 返回 HTTP504错误码。
取值：1-300s。
使用说明：
● 仅支持协议为HTTP/HTTPS/
QUIC的监听器。
最小值：1 最大值：300
client_timeout 否 Integer 等待客户端请求超时时间，仅限 协议为HTTP/HTTPS/QUIC的监 听器配置。取值范围为1-300s, 默认值为60s TCP，UDP协议的 监听器不支持此字段
● TCP/UDP监听器：
10-4000s。
● HTTP/HTTPS/
TERMINATED_HTTPS/QUIC 监听器：0-4000s。
● UDP监听器不支持此字段。
ipgroup 否 UpdateListen erIpGroupOp tion object
listener对象中的ipgroup信息
参数 是否必选 参数类型 描述 transparent_cl
ient_ip_enable 否 Boolean 是否透传客户端IP地址。开启后 客户端IP地址将透传到后端服务 器。仅作用于共享型LB的 TCP/UDP监听器。取值：
● 共享型LB的TCP/UDP监听器 可设置为true或false。
● 共享型LB的HTTP/
TERMINATED_HTTPS监听器 只支持设置为true。
● 独享型负载均衡器所有协议 的监听器只支持设置为 true。
使用说明：
● 开启特性后，ELB和后端服务 器之间直接使用真实的IP访 问，需要确保已正确设置服 务器的安全组以及访问控制 策略。
● 开启特性后，不支持同一台 服务器既作为后端服务器又 作为客户端的场景。
● 开启特性后，不支持变更后 端服务器规格。
参数 是否必选 参数类型 描述 enhance_l7pol
icy_enable 否 Boolean 是否开启高级转发策略功能。开 启高级转发策略后，支持更灵活 的转发策略和转发规则设置。取 值：true开启，false不开启。
开启后支持如下场景：
● 转发策略的action字段支持 指定为REDIRECT_TO_URL, FIXED_RESPONSE，即支持 URL重定向和响应固定的内 容给客户端。
● 转发策略支持指定priority、
redirect_url_config、
fixed_response_config字 段。
● 转发规则rule的type可以指定 METHOD, HEADER,
QUERY_STRING,
SOURCE_IP这几种取值。
● 转发规则rule的type为 HOST_NAME时，转发规则 rule的value支持通配符*。
● 转发规则支持指定conditions 字段。
表4-242 ListenerInsertHeaders
参数 是否必选 参数类型 描述
X-Forwarded-ELB-IP 否 Boolean X-Forwarded-ELB-IP设为true可 以将ELB实例的eip地址从报文的 http头中带到后端云服务器。
缺省值：false
X-Forwarded-Port 否 Boolean X-Forwarded-Port设为true可以 将ELB实例的监听端口从报文的 http头中带到后端云服务器。
缺省值：false
X-Forwarded-For-Port 否 Boolean X-Forwarded-For-Port设为true 可以将客户端的源端口从报文的 http头中带到后端云服务器。
缺省值：false
参数 是否必选 参数类型 描述
X-Forwarded-Host 否 Boolean X-Forwarded-Host设为true可
以将客户请求头的X-Forwarded-Host设置为请求头 的Host带到后端云服务器。
缺省值：true
表4-243 UpdateListenerIpGroupOption
参数 是否必选 参数类型 描述
ipgroup_id 否 String 监听器关联的访问控制组的id。
创建时必选，更新时非必选。
指定的ipgroup必须已存在，不 能指定为null，否则与
enable_ipgroup冲突。
最小长度：1 最大长度：36 enable_ipgrou
p 否 Boolean 访问控制组的状态。 True:开启
访问控制； False：关闭访问控 制； 开启访问控制的监听器，
允许直接删除。
type 否 String 访问控制组的类型。 white:白名 单，只允许指定ip访问； black:
黑名单，不允许指定ip访问；
响应参数
状态码： 200
表4-244 响应 Body 参数
参数 参数类型 描述
request_id String 请求ID。
注：自动生成 。 listener Listener
object 监听器对象。