huaweicloudsdkelb 3.1.109__py2.py3-none-any.whl → 3.1.111__py2.py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- huaweicloudsdkelb/v2/region/elb_region.py +3 -0
- huaweicloudsdkelb/v3/elb_async_client.py +1 -1
- huaweicloudsdkelb/v3/elb_client.py +1 -1
- huaweicloudsdkelb/v3/model/autoscaling_ref.py +6 -6
- huaweicloudsdkelb/v3/model/availability_zone.py +15 -15
- huaweicloudsdkelb/v3/model/bandwidth_ref.py +3 -3
- huaweicloudsdkelb/v3/model/batch_create_members_option.py +6 -6
- huaweicloudsdkelb/v3/model/batch_create_members_request.py +3 -3
- huaweicloudsdkelb/v3/model/batch_delete_members_request.py +3 -3
- huaweicloudsdkelb/v3/model/batch_member.py +6 -6
- huaweicloudsdkelb/v3/model/batch_update_members_option.py +3 -3
- huaweicloudsdkelb/v3/model/batch_update_members_request.py +3 -3
- huaweicloudsdkelb/v3/model/batch_update_policies_priority_request_body.py +3 -3
- huaweicloudsdkelb/v3/model/batch_update_priority_request_body.py +6 -6
- huaweicloudsdkelb/v3/model/create_fixted_response_config.py +9 -9
- huaweicloudsdkelb/v3/model/create_health_monitor_option.py +12 -12
- huaweicloudsdkelb/v3/model/create_insert_header_config.py +9 -9
- huaweicloudsdkelb/v3/model/create_insert_headers_config.py +3 -3
- huaweicloudsdkelb/v3/model/create_ip_group_ip_option.py +3 -3
- huaweicloudsdkelb/v3/model/create_l7_policy_option.py +39 -39
- huaweicloudsdkelb/v3/model/create_l7_policy_response.py +3 -3
- huaweicloudsdkelb/v3/model/create_l7_policy_rule_option.py +21 -21
- huaweicloudsdkelb/v3/model/create_l7_rule_request.py +3 -3
- huaweicloudsdkelb/v3/model/create_l7_rule_response.py +3 -3
- huaweicloudsdkelb/v3/model/create_listener_ip_group_option.py +9 -9
- huaweicloudsdkelb/v3/model/create_listener_option.py +84 -84
- huaweicloudsdkelb/v3/model/create_listener_quic_config_option.py +6 -6
- huaweicloudsdkelb/v3/model/create_listener_response.py +3 -3
- huaweicloudsdkelb/v3/model/create_load_balancer_bandwidth_option.py +6 -6
- huaweicloudsdkelb/v3/model/create_load_balancer_option.py +45 -45
- huaweicloudsdkelb/v3/model/create_load_balancer_public_ip_option.py +3 -3
- huaweicloudsdkelb/v3/model/create_load_balancer_response.py +9 -9
- huaweicloudsdkelb/v3/model/create_loadbalancer_autoscaling_option.py +3 -3
- huaweicloudsdkelb/v3/model/create_master_slave_health_monitor_option.py +3 -3
- huaweicloudsdkelb/v3/model/create_member_option.py +21 -21
- huaweicloudsdkelb/v3/model/create_member_request.py +3 -3
- huaweicloudsdkelb/v3/model/create_member_response.py +3 -3
- huaweicloudsdkelb/v3/model/create_pool_option.py +12 -12
- huaweicloudsdkelb/v3/model/create_pool_session_persistence_option.py +3 -3
- huaweicloudsdkelb/v3/model/create_redirect_pools_config.py +6 -6
- huaweicloudsdkelb/v3/model/create_redirect_pools_extend_config.py +3 -3
- huaweicloudsdkelb/v3/model/create_redirect_pools_sticky_session_config.py +6 -6
- huaweicloudsdkelb/v3/model/create_redirect_url_config.py +18 -18
- huaweicloudsdkelb/v3/model/create_remove_header_config.py +3 -3
- huaweicloudsdkelb/v3/model/create_remove_headers_config.py +3 -3
- huaweicloudsdkelb/v3/model/create_rewrite_url_config.py +9 -9
- huaweicloudsdkelb/v3/model/create_rule_condition.py +6 -6
- huaweicloudsdkelb/v3/model/create_rule_option.py +24 -24
- huaweicloudsdkelb/v3/model/create_traffic_limit_config.py +9 -9
- huaweicloudsdkelb/v3/model/delete_l7_policy_request.py +3 -3
- huaweicloudsdkelb/v3/model/delete_master_slave_pool_request.py +3 -3
- huaweicloudsdkelb/v3/model/delete_member_request.py +3 -3
- huaweicloudsdkelb/v3/model/delete_pool_request.py +3 -3
- huaweicloudsdkelb/v3/model/eip_info.py +9 -9
- huaweicloudsdkelb/v3/model/fixted_response_config.py +9 -9
- huaweicloudsdkelb/v3/model/flavor.py +6 -6
- huaweicloudsdkelb/v3/model/flavor_info.py +18 -18
- huaweicloudsdkelb/v3/model/global_eip_info.py +9 -9
- huaweicloudsdkelb/v3/model/health_monitor.py +12 -12
- huaweicloudsdkelb/v3/model/insert_header_config.py +9 -9
- huaweicloudsdkelb/v3/model/insert_headers_config.py +3 -3
- huaweicloudsdkelb/v3/model/l7_policy.py +51 -51
- huaweicloudsdkelb/v3/model/l7_rule.py +36 -36
- huaweicloudsdkelb/v3/model/list_availability_zones_request.py +3 -3
- huaweicloudsdkelb/v3/model/list_availability_zones_response.py +38 -9
- huaweicloudsdkelb/v3/model/list_flavors_request.py +9 -9
- huaweicloudsdkelb/v3/model/list_health_monitors_request.py +9 -9
- huaweicloudsdkelb/v3/model/list_l7_policies_request.py +48 -48
- huaweicloudsdkelb/v3/model/list_l7_policies_response.py +6 -6
- huaweicloudsdkelb/v3/model/list_l7_rules_request.py +3 -3
- huaweicloudsdkelb/v3/model/list_l7_rules_response.py +6 -6
- huaweicloudsdkelb/v3/model/list_listeners_request.py +9 -9
- huaweicloudsdkelb/v3/model/list_listeners_response.py +6 -6
- huaweicloudsdkelb/v3/model/list_load_balancers_request.py +6 -6
- huaweicloudsdkelb/v3/model/list_master_slave_pools_request.py +3 -3
- huaweicloudsdkelb/v3/model/list_members_request.py +3 -3
- huaweicloudsdkelb/v3/model/list_pools_request.py +3 -3
- huaweicloudsdkelb/v3/model/listener.py +96 -96
- huaweicloudsdkelb/v3/model/listener_insert_headers.py +27 -27
- huaweicloudsdkelb/v3/model/listener_ip_group.py +9 -9
- huaweicloudsdkelb/v3/model/listener_quic_config.py +6 -6
- huaweicloudsdkelb/v3/model/load_balancer.py +129 -129
- huaweicloudsdkelb/v3/model/load_balancer_ref.py +3 -3
- huaweicloudsdkelb/v3/model/load_balancer_status_pool.py +3 -3
- huaweicloudsdkelb/v3/model/logtank.py +3 -3
- huaweicloudsdkelb/v3/model/master_slave_health_monitor.py +6 -6
- huaweicloudsdkelb/v3/model/member.py +45 -45
- huaweicloudsdkelb/v3/model/member_info.py +6 -6
- huaweicloudsdkelb/v3/model/member_status.py +6 -6
- huaweicloudsdkelb/v3/model/pool.py +6 -6
- huaweicloudsdkelb/v3/model/pool_ref.py +3 -3
- huaweicloudsdkelb/v3/model/prepaid_create_option.py +3 -3
- huaweicloudsdkelb/v3/model/public_ip_info.py +9 -9
- huaweicloudsdkelb/v3/model/quota.py +3 -3
- huaweicloudsdkelb/v3/model/redirect_pools_config.py +6 -6
- huaweicloudsdkelb/v3/model/redirect_pools_extend_config.py +3 -3
- huaweicloudsdkelb/v3/model/redirect_pools_sticky_session_config.py +6 -6
- huaweicloudsdkelb/v3/model/redirect_url_config.py +18 -18
- huaweicloudsdkelb/v3/model/remove_header_config.py +3 -3
- huaweicloudsdkelb/v3/model/remove_headers_config.py +3 -3
- huaweicloudsdkelb/v3/model/rewrite_url_config.py +9 -9
- huaweicloudsdkelb/v3/model/rule_condition.py +6 -6
- huaweicloudsdkelb/v3/model/rule_ref.py +3 -3
- huaweicloudsdkelb/v3/model/show_l7_policy_request.py +3 -3
- huaweicloudsdkelb/v3/model/show_l7_policy_response.py +3 -3
- huaweicloudsdkelb/v3/model/show_l7_rule_response.py +3 -3
- huaweicloudsdkelb/v3/model/show_listener_response.py +3 -3
- huaweicloudsdkelb/v3/model/show_load_balancer_response.py +3 -3
- huaweicloudsdkelb/v3/model/show_load_balancer_status_response.py +3 -3
- huaweicloudsdkelb/v3/model/show_master_slave_pool_request.py +3 -3
- huaweicloudsdkelb/v3/model/show_member_request.py +3 -3
- huaweicloudsdkelb/v3/model/show_pool_request.py +3 -3
- huaweicloudsdkelb/v3/model/tag.py +6 -6
- huaweicloudsdkelb/v3/model/traffic_limit_config.py +9 -9
- huaweicloudsdkelb/v3/model/upadate_ip_group_ip_option.py +3 -3
- huaweicloudsdkelb/v3/model/update_fixted_response_config.py +9 -9
- huaweicloudsdkelb/v3/model/update_health_monitor_option.py +12 -12
- huaweicloudsdkelb/v3/model/update_insert_header_config.py +9 -9
- huaweicloudsdkelb/v3/model/update_insert_headers_config.py +3 -3
- huaweicloudsdkelb/v3/model/update_l7_policy_option.py +24 -24
- huaweicloudsdkelb/v3/model/update_l7_policy_request.py +3 -3
- huaweicloudsdkelb/v3/model/update_l7_policy_response.py +3 -3
- huaweicloudsdkelb/v3/model/update_l7_rule_option.py +18 -18
- huaweicloudsdkelb/v3/model/update_l7_rule_response.py +3 -3
- huaweicloudsdkelb/v3/model/update_listener_ip_group_option.py +9 -9
- huaweicloudsdkelb/v3/model/update_listener_option.py +66 -66
- huaweicloudsdkelb/v3/model/update_listener_quic_config_option.py +6 -6
- huaweicloudsdkelb/v3/model/update_listener_response.py +3 -3
- huaweicloudsdkelb/v3/model/update_load_balancer_option.py +48 -48
- huaweicloudsdkelb/v3/model/update_load_balancer_response.py +9 -9
- huaweicloudsdkelb/v3/model/update_loadbalancer_autoscaling_option.py +6 -6
- huaweicloudsdkelb/v3/model/update_member_option.py +3 -3
- huaweicloudsdkelb/v3/model/update_member_request.py +3 -3
- huaweicloudsdkelb/v3/model/update_pool_option.py +9 -9
- huaweicloudsdkelb/v3/model/update_pool_request.py +3 -3
- huaweicloudsdkelb/v3/model/update_pool_session_persistence_option.py +3 -3
- huaweicloudsdkelb/v3/model/update_redirect_pools_config.py +6 -6
- huaweicloudsdkelb/v3/model/update_redirect_pools_extend_config.py +3 -3
- huaweicloudsdkelb/v3/model/update_redirect_pools_sticky_session_config.py +6 -6
- huaweicloudsdkelb/v3/model/update_redirect_url_config.py +18 -18
- huaweicloudsdkelb/v3/model/update_remove_header_config.py +3 -3
- huaweicloudsdkelb/v3/model/update_remove_headers_config.py +3 -3
- huaweicloudsdkelb/v3/model/update_rewrite_url_config.py +9 -9
- huaweicloudsdkelb/v3/model/update_rule_condition.py +6 -6
- huaweicloudsdkelb/v3/model/update_traffic_limit_config.py +9 -9
- huaweicloudsdkelb/v3/region/elb_region.py +3 -0
- {huaweicloudsdkelb-3.1.109.dist-info → huaweicloudsdkelb-3.1.111.dist-info}/METADATA +2 -2
- {huaweicloudsdkelb-3.1.109.dist-info → huaweicloudsdkelb-3.1.111.dist-info}/RECORD +151 -151
- {huaweicloudsdkelb-3.1.109.dist-info → huaweicloudsdkelb-3.1.111.dist-info}/LICENSE +0 -0
- {huaweicloudsdkelb-3.1.109.dist-info → huaweicloudsdkelb-3.1.111.dist-info}/WHEEL +0 -0
- {huaweicloudsdkelb-3.1.109.dist-info → huaweicloudsdkelb-3.1.111.dist-info}/top_level.txt +0 -0
@@ -97,75 +97,75 @@ class Listener:
|
|
97
97
|
|
98
98
|
The model defined in huaweicloud sdk
|
99
99
|
|
100
|
-
:param admin_state_up:
|
100
|
+
:param admin_state_up: 参数解释:监听器的管理状态。 [不支持该字段,请勿使用。](tag:dt,dt_test,hcso_dt)
|
101
101
|
:type admin_state_up: bool
|
102
|
-
:param client_ca_tls_container_ref:
|
102
|
+
:param client_ca_tls_container_ref: 参数解释:监听器使用的CA证书ID。 约束限制:当且仅当type=client时,才会使用该字段对应的证书。
|
103
103
|
:type client_ca_tls_container_ref: str
|
104
|
-
:param connection_limit:
|
104
|
+
:param connection_limit: 参数解释:监听器的最大连接数。 取值范围:-1表示不限制。 默认取值:-1。 不支持该字段,请勿使用。
|
105
105
|
:type connection_limit: int
|
106
|
-
:param created_at:
|
106
|
+
:param created_at: 参数解释:监听器的创建时间。 取值范围: 格式:yyyy-MM-dd'T'HH:mm:ss'Z',如:2021-07-30T12:03:44Z
|
107
107
|
:type created_at: str
|
108
|
-
:param default_pool_id:
|
108
|
+
:param default_pool_id: 参数解释:监听器的默认后端云服务器组ID。当请求没有匹配的转发策略时,转发到默认后端云服务器上处理。
|
109
109
|
:type default_pool_id: str
|
110
|
-
:param default_tls_container_ref:
|
110
|
+
:param default_tls_container_ref: 参数解释:监听器使用的服务器证书ID。
|
111
111
|
:type default_tls_container_ref: str
|
112
|
-
:param description:
|
112
|
+
:param description: 参数解释:监听器的描述信息。
|
113
113
|
:type description: str
|
114
|
-
:param http2_enable:
|
114
|
+
:param http2_enable: 参数解释:客户端与LB之间的HTTPS请求的HTTP2功能的开启状态。 开启后,可提升客户端与LB间的访问性能,但LB与后端服务器间仍采用HTTP1.X协议。 约束限制: - 仅HTTPS协议监听器有效。 - QUIC监听器不能设置该字段,固定返回为true。 - 其他协议的监听器可设置该字段但无效,无论取值如何都不影响监听器正常运行。 [不支持QUIC。](tag:tm,hws_eu,g42,hk_g42,hcso_dt,dt,dt_test)
|
115
115
|
:type http2_enable: bool
|
116
|
-
:param id:
|
116
|
+
:param id: 参数解释:监听器ID。
|
117
117
|
:type id: str
|
118
118
|
:param insert_headers:
|
119
119
|
:type insert_headers: :class:`huaweicloudsdkelb.v3.ListenerInsertHeaders`
|
120
|
-
:param loadbalancers:
|
120
|
+
:param loadbalancers: 参数解释:监听器所属的负载均衡器的ID列表。 约束限制:一个监听器只支持关联到一个LB。
|
121
121
|
:type loadbalancers: list[:class:`huaweicloudsdkelb.v3.LoadBalancerRef`]
|
122
|
-
:param name:
|
122
|
+
:param name: 参数解释:监听器的名称。 约束限制:若名称为空,则在控制台的监听器列表无法选择并查看监听器详情。
|
123
123
|
:type name: str
|
124
|
-
:param project_id:
|
124
|
+
:param project_id: 参数解释:监听器所在的项目ID。
|
125
125
|
:type project_id: str
|
126
|
-
:param protocol:
|
126
|
+
:param protocol: 参数解释:监听器的监听协议。 [取值范围:TCP、UDP、HTTP、HTTPS、TERMINATED_HTTPS、QUIC、TLS。 约束限制: - 共享型LB上的HTTPS监听器只支持设置为TERMINATED_HTTPS, 创建时传入HTTPS将会自动转为TERMINATED_HTTPS。 - 独享型LB上的HTTPS监听器只支持设置为HTTPS,创建时传入TERMINATED_HTTPS将会自动转为HTTPS。 ](tag:hws,hws_hk,ocb,ctc,hcs,g42,tm,cmcc,hk_g42,hws_ocb,hk_vdf,fcs,dt) [取值:TCP、UDP、HTTP、HTTPS。](tag:hcso_dt) [取值:TCP、UDP、IP、HTTP、HTTPS。IP为网关型LB上的监听器独有的协议。](tag:hws_eu) [不支持QUIC。](tag:tm,hws_eu,g42,hk_g42,hcso_dt,dt,dt_test)
|
127
127
|
:type protocol: str
|
128
|
-
:param protocol_port:
|
128
|
+
:param protocol_port: 参数解释:监听器的监听端口。 约束限制: - QUIC监听器端口不能是4789,且不能和UDP监听器端口重复。 - 传0表示开启监听端口范围的能力,此时port_ranges为必填字段。 [-不支持QUIC。](tag:tm,hws_eu,g42,hk_g42,hcso_dt,dt,dt_test)
|
129
129
|
:type protocol_port: int
|
130
|
-
:param sni_container_refs:
|
130
|
+
:param sni_container_refs: 参数解释:监听器使用的SNI证书(带域名的服务器证书)ID列表。 约束限制: - 列表对应的所有SNI证书的域名不允许存在重复。 - 列表对应的所有SNI证书的域名总数不超过50。
|
131
131
|
:type sni_container_refs: list[str]
|
132
|
-
:param sni_match_algo:
|
132
|
+
:param sni_match_algo: 参数解释:监听器使用的SNI证书泛域名匹配方式。 取值范围:longest_suffix表示最长尾缀匹配;wildcard表示标准域名分级匹配。 默认取值:wildcard
|
133
133
|
:type sni_match_algo: str
|
134
|
-
:param tags:
|
134
|
+
:param tags: 参数解释:标签列表。
|
135
135
|
:type tags: list[:class:`huaweicloudsdkelb.v3.Tag`]
|
136
|
-
:param updated_at:
|
136
|
+
:param updated_at: 参数解释:监听器的更新时间。 取值范围: 格式:yyyy-MM-dd'T'HH:mm:ss'Z',如:2021-07-30T12:03:44Z
|
137
137
|
:type updated_at: str
|
138
|
-
:param tls_ciphers_policy:
|
138
|
+
:param tls_ciphers_policy: 参数解释:监听器使用的安全策略。 [取值范围: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、tls-1-2-strict-no-cbc,默认:tls-1-0。 ](tag:hws,hws_hk,ocb,tlf,ctc,hcso,sbc,tm,cmcc,dt) [取值范围:tls-1-0、tls-1-1、tls-1-2、 tls-1-2-strict,默认:tls-1-0。](tag:hws_eu,g42,hk_g42,hcso_dt) [约束限制: - 仅对HTTPS协议类型的监听器且关联LB为独享型时有效。 - QUIC监听器不支持该字段。 - 若同时设置了security_policy_id和tls_ciphers_policy,则仅security_policy_id生效。 - 加密套件的优先顺序为ecc套件、rsa套件、tls1.3协议的套件(即支持ecc又支持rsa) ](tag:hws,hws_hk,hws_eu,ocb,tlf,ctc,hcso,sbc,g42,tm,cmcc,hk-g42,dt) [约束限制: - 仅对HTTPS协议类型的监听器有效](tag:hcso_dt) [不支持tls1.3协议的套件。](tag:tm,hws_eu,g42,hk_g42) [不支持QUIC。](tag:tm,dt,dt_test)
|
139
139
|
:type tls_ciphers_policy: str
|
140
|
-
:param security_policy_id:
|
140
|
+
:param security_policy_id: 参数解释:自定义安全策略的ID。 [约束限制: - 仅对HTTPS协议类型的监听器且关联LB为独享型时有效。 - 若同时设置了security_policy_id和tls_ciphers_policy,则仅security_policy_id生效。 - 加密套件的优先顺序为ecc套件、rsa套件、tls1.3协议的套件(即支持ecc又支持rsa) ](tag:hws,hws_hk,hws_eu,ocb,ctc,hcso,g42,tm,cmcc,hk-g42,dt) [约束限制: - 仅对HTTPS协议类型的监听器有效](tag:hcso_dt) [不支持tls1.3协议的套件。](tag:tm,hws_eu,g42,hk_g42)
|
141
141
|
:type security_policy_id: str
|
142
|
-
:param enable_member_retry:
|
142
|
+
:param enable_member_retry: 参数解释:是否开启后端服务器的重试。 [约束限制: - 若关联是共享型LB,仅在protocol为HTTP、TERMINATED_HTTPS时才能传入该字段。 - 若关联是独享型LB,仅在protocol为HTTP、HTTPS和QUIC时才能传入该字段。 ](tag:hws,hws_hk,ocb,ctc,hcs,g42,tm,cmcc,hk_g42,hws_ocb,hk_vdf,fcs,dt) [约束限制: - 仅在protocol为HTTP、HTTPS时才能传入该字段。](tag:hws_eu,hcso_dt) 取值范围:true 开启重试,false 不开启重试。 默认取值:true。 [不支持QUIC。](tag:tm,dt,dt_test)
|
143
143
|
:type enable_member_retry: bool
|
144
|
-
:param keepalive_timeout:
|
144
|
+
:param keepalive_timeout: 参数解释:客户端连接空闲超时时间。在超过keepalive_timeout时长一直没有请求, 负载均衡会暂时中断当前连接,直到下一次请求时重新建立新的连接。 约束限制:共享型实例的UDP监听器不支持此字段。 取值范围: - TCP监听器[和IP监听器](tag:hws_eu):10-4000s,默认值为300s。 - 若为HTTP/HTTPS/TERMINATED_HTTPS监听器,取值范围为(0-4000s)默认值为60s。
|
145
145
|
:type keepalive_timeout: int
|
146
|
-
:param client_timeout:
|
146
|
+
:param client_timeout: 参数解释:等待客户端请求超时时间,包括两种情况: - 读取整个客户端请求头的超时时长:如果客户端未在超时时长内发送完整个请求头,则请求将被中断 - 两个连续body体的数据包到达LB的时间间隔,超出client_timeout将会断开连接。 约束限制:仅协议为HTTP/HTTPS的监听器支持该字段。 取值范围:1-3600s 默认取值:60s。
|
147
147
|
:type client_timeout: int
|
148
|
-
:param member_timeout:
|
148
|
+
:param member_timeout: 参数解释:等待后端服务器响应超时时间。请求转发后端服务器后,在等待超时member_timeout时长没有响应,负载均衡将终止等待,并返回HTTP504错误码。 约束限制:仅支持协议为HTTP/HTTPS的监听器。 取值范围:1-3600s 默认取值:60s。
|
149
149
|
:type member_timeout: int
|
150
150
|
:param ipgroup:
|
151
151
|
:type ipgroup: :class:`huaweicloudsdkelb.v3.ListenerIpGroup`
|
152
|
-
:param transparent_client_ip_enable:
|
152
|
+
:param transparent_client_ip_enable: 参数解释:是否透传客户端IP地址。开启后客户端IP地址将透传到后端服务器。 [仅作用于共享型LB的TCP/UDP监听器。 约束限制: - 开启特性后,ELB和后端服务器之间直接使用真实的IP访问,需要确保已正确设置服务器的安全组以及访问控制策略。 - 开启特性后,不支持同一台服务器既作为后端服务器又作为客户端的场景。 - 开启特性后,不支持变更后端服务器规格。 ](tag:hws,hws_hk,ocb,ctc,hcs,g42,tm,cmcc,hk_g42,hws_ocb,hk_vdf,fcs,dt) 取值范围: - 共享型LB的TCP/UDP监听器可设置为true或false,不传默认为false。 - 共享型LB的HTTP/HTTPS监听器只支持设置为true,不传默认为true。 - 独享型负载均衡器所有协议的监听器只支持设置为true,不传默认为true。 [只设支持置为true,不传默认为true。](tag:hws_eu,hcso_dt)
|
153
153
|
:type transparent_client_ip_enable: bool
|
154
|
-
:param proxy_protocol_enable:
|
154
|
+
:param proxy_protocol_enable: 参数解释:是否开启proxy_protocol。仅TLS监听器可指定,其他协议的监听器该字段不生效,proxy_protocol不开启。
|
155
155
|
:type proxy_protocol_enable: bool
|
156
|
-
:param enhance_l7policy_enable:
|
156
|
+
:param enhance_l7policy_enable: 参数解释:是否开启高级转发策略功能。开启高级转发策略后,支持更灵活的转发策略和转发规则设置。 开启后支持如下场景: - 转发策略的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字段。 取值范围:true开启,false不开启。 默认取值:false。 [荷兰region不支持该字段,请勿使用。](tag:dt,dt_test)
|
157
157
|
:type enhance_l7policy_enable: bool
|
158
158
|
:param quic_config:
|
159
159
|
:type quic_config: :class:`huaweicloudsdkelb.v3.ListenerQuicConfig`
|
160
|
-
:param protection_status:
|
160
|
+
:param protection_status: 参数解释:修改保护状态, 取值范围: - nonProtection: 不保护,默认值为nonProtection - consoleProtection: 控制台修改保护
|
161
161
|
:type protection_status: str
|
162
|
-
:param protection_reason:
|
162
|
+
:param protection_reason: 参数解释:设置保护的原因。 约束限制: 仅当protection_status为consoleProtection时有效。
|
163
163
|
:type protection_reason: str
|
164
|
-
:param gzip_enable: ELB是否开启gzip
|
164
|
+
:param gzip_enable: 参数解释:ELB是否开启gzip压缩。 [约束限制:仅HTTP/HTTPS类型监听器支持配置。](tag:tm,hws_eu,g42,hk_g42,hcso_dt,dt,dt_test) [约束限制:仅HTTP/HTTPS/QUIC类型监听器支持配置。](tag:hws,hws_hk,hws_test,hcs,hcs_sm,hcso,hk_vdf,fcs,fcs_vm,mix,ocb,ctc,cmcc,sbc,hws_ocb,hk_sbc) 默认取值:false
|
165
165
|
:type gzip_enable: bool
|
166
|
-
:param port_ranges:
|
166
|
+
:param port_ranges: 参数解释:端口监听范围(闭区间)。 约束限制: - 最多指定10个端口组,每个组范围不可有重叠部分 - 仅当protocol_port为0时可以传入。
|
167
167
|
:type port_ranges: list[:class:`huaweicloudsdkelb.v3.PortRange`]
|
168
|
-
:param ssl_early_data_enable:
|
168
|
+
:param ssl_early_data_enable: 参数解释:监听器0-RTT能力开关 约束限制:仅HTTPS类型监听器支持配置,需要依赖TLSv1.3安全策略协议。 默认取值:false。
|
169
169
|
:type ssl_early_data_enable: bool
|
170
170
|
"""
|
171
171
|
|
@@ -255,7 +255,7 @@ class Listener:
|
|
255
255
|
def admin_state_up(self):
|
256
256
|
"""Gets the admin_state_up of this Listener.
|
257
257
|
|
258
|
-
|
258
|
+
参数解释:监听器的管理状态。 [不支持该字段,请勿使用。](tag:dt,dt_test,hcso_dt)
|
259
259
|
|
260
260
|
:return: The admin_state_up of this Listener.
|
261
261
|
:rtype: bool
|
@@ -266,7 +266,7 @@ class Listener:
|
|
266
266
|
def admin_state_up(self, admin_state_up):
|
267
267
|
"""Sets the admin_state_up of this Listener.
|
268
268
|
|
269
|
-
|
269
|
+
参数解释:监听器的管理状态。 [不支持该字段,请勿使用。](tag:dt,dt_test,hcso_dt)
|
270
270
|
|
271
271
|
:param admin_state_up: The admin_state_up of this Listener.
|
272
272
|
:type admin_state_up: bool
|
@@ -277,7 +277,7 @@ class Listener:
|
|
277
277
|
def client_ca_tls_container_ref(self):
|
278
278
|
"""Gets the client_ca_tls_container_ref of this Listener.
|
279
279
|
|
280
|
-
|
280
|
+
参数解释:监听器使用的CA证书ID。 约束限制:当且仅当type=client时,才会使用该字段对应的证书。
|
281
281
|
|
282
282
|
:return: The client_ca_tls_container_ref of this Listener.
|
283
283
|
:rtype: str
|
@@ -288,7 +288,7 @@ class Listener:
|
|
288
288
|
def client_ca_tls_container_ref(self, client_ca_tls_container_ref):
|
289
289
|
"""Sets the client_ca_tls_container_ref of this Listener.
|
290
290
|
|
291
|
-
|
291
|
+
参数解释:监听器使用的CA证书ID。 约束限制:当且仅当type=client时,才会使用该字段对应的证书。
|
292
292
|
|
293
293
|
:param client_ca_tls_container_ref: The client_ca_tls_container_ref of this Listener.
|
294
294
|
:type client_ca_tls_container_ref: str
|
@@ -299,7 +299,7 @@ class Listener:
|
|
299
299
|
def connection_limit(self):
|
300
300
|
"""Gets the connection_limit of this Listener.
|
301
301
|
|
302
|
-
|
302
|
+
参数解释:监听器的最大连接数。 取值范围:-1表示不限制。 默认取值:-1。 不支持该字段,请勿使用。
|
303
303
|
|
304
304
|
:return: The connection_limit of this Listener.
|
305
305
|
:rtype: int
|
@@ -310,7 +310,7 @@ class Listener:
|
|
310
310
|
def connection_limit(self, connection_limit):
|
311
311
|
"""Sets the connection_limit of this Listener.
|
312
312
|
|
313
|
-
|
313
|
+
参数解释:监听器的最大连接数。 取值范围:-1表示不限制。 默认取值:-1。 不支持该字段,请勿使用。
|
314
314
|
|
315
315
|
:param connection_limit: The connection_limit of this Listener.
|
316
316
|
:type connection_limit: int
|
@@ -321,7 +321,7 @@ class Listener:
|
|
321
321
|
def created_at(self):
|
322
322
|
"""Gets the created_at of this Listener.
|
323
323
|
|
324
|
-
|
324
|
+
参数解释:监听器的创建时间。 取值范围: 格式:yyyy-MM-dd'T'HH:mm:ss'Z',如:2021-07-30T12:03:44Z
|
325
325
|
|
326
326
|
:return: The created_at of this Listener.
|
327
327
|
:rtype: str
|
@@ -332,7 +332,7 @@ class Listener:
|
|
332
332
|
def created_at(self, created_at):
|
333
333
|
"""Sets the created_at of this Listener.
|
334
334
|
|
335
|
-
|
335
|
+
参数解释:监听器的创建时间。 取值范围: 格式:yyyy-MM-dd'T'HH:mm:ss'Z',如:2021-07-30T12:03:44Z
|
336
336
|
|
337
337
|
:param created_at: The created_at of this Listener.
|
338
338
|
:type created_at: str
|
@@ -343,7 +343,7 @@ class Listener:
|
|
343
343
|
def default_pool_id(self):
|
344
344
|
"""Gets the default_pool_id of this Listener.
|
345
345
|
|
346
|
-
|
346
|
+
参数解释:监听器的默认后端云服务器组ID。当请求没有匹配的转发策略时,转发到默认后端云服务器上处理。
|
347
347
|
|
348
348
|
:return: The default_pool_id of this Listener.
|
349
349
|
:rtype: str
|
@@ -354,7 +354,7 @@ class Listener:
|
|
354
354
|
def default_pool_id(self, default_pool_id):
|
355
355
|
"""Sets the default_pool_id of this Listener.
|
356
356
|
|
357
|
-
|
357
|
+
参数解释:监听器的默认后端云服务器组ID。当请求没有匹配的转发策略时,转发到默认后端云服务器上处理。
|
358
358
|
|
359
359
|
:param default_pool_id: The default_pool_id of this Listener.
|
360
360
|
:type default_pool_id: str
|
@@ -365,7 +365,7 @@ class Listener:
|
|
365
365
|
def default_tls_container_ref(self):
|
366
366
|
"""Gets the default_tls_container_ref of this Listener.
|
367
367
|
|
368
|
-
|
368
|
+
参数解释:监听器使用的服务器证书ID。
|
369
369
|
|
370
370
|
:return: The default_tls_container_ref of this Listener.
|
371
371
|
:rtype: str
|
@@ -376,7 +376,7 @@ class Listener:
|
|
376
376
|
def default_tls_container_ref(self, default_tls_container_ref):
|
377
377
|
"""Sets the default_tls_container_ref of this Listener.
|
378
378
|
|
379
|
-
|
379
|
+
参数解释:监听器使用的服务器证书ID。
|
380
380
|
|
381
381
|
:param default_tls_container_ref: The default_tls_container_ref of this Listener.
|
382
382
|
:type default_tls_container_ref: str
|
@@ -387,7 +387,7 @@ class Listener:
|
|
387
387
|
def description(self):
|
388
388
|
"""Gets the description of this Listener.
|
389
389
|
|
390
|
-
|
390
|
+
参数解释:监听器的描述信息。
|
391
391
|
|
392
392
|
:return: The description of this Listener.
|
393
393
|
:rtype: str
|
@@ -398,7 +398,7 @@ class Listener:
|
|
398
398
|
def description(self, description):
|
399
399
|
"""Sets the description of this Listener.
|
400
400
|
|
401
|
-
|
401
|
+
参数解释:监听器的描述信息。
|
402
402
|
|
403
403
|
:param description: The description of this Listener.
|
404
404
|
:type description: str
|
@@ -409,7 +409,7 @@ class Listener:
|
|
409
409
|
def http2_enable(self):
|
410
410
|
"""Gets the http2_enable of this Listener.
|
411
411
|
|
412
|
-
|
412
|
+
参数解释:客户端与LB之间的HTTPS请求的HTTP2功能的开启状态。 开启后,可提升客户端与LB间的访问性能,但LB与后端服务器间仍采用HTTP1.X协议。 约束限制: - 仅HTTPS协议监听器有效。 - QUIC监听器不能设置该字段,固定返回为true。 - 其他协议的监听器可设置该字段但无效,无论取值如何都不影响监听器正常运行。 [不支持QUIC。](tag:tm,hws_eu,g42,hk_g42,hcso_dt,dt,dt_test)
|
413
413
|
|
414
414
|
:return: The http2_enable of this Listener.
|
415
415
|
:rtype: bool
|
@@ -420,7 +420,7 @@ class Listener:
|
|
420
420
|
def http2_enable(self, http2_enable):
|
421
421
|
"""Sets the http2_enable of this Listener.
|
422
422
|
|
423
|
-
|
423
|
+
参数解释:客户端与LB之间的HTTPS请求的HTTP2功能的开启状态。 开启后,可提升客户端与LB间的访问性能,但LB与后端服务器间仍采用HTTP1.X协议。 约束限制: - 仅HTTPS协议监听器有效。 - QUIC监听器不能设置该字段,固定返回为true。 - 其他协议的监听器可设置该字段但无效,无论取值如何都不影响监听器正常运行。 [不支持QUIC。](tag:tm,hws_eu,g42,hk_g42,hcso_dt,dt,dt_test)
|
424
424
|
|
425
425
|
:param http2_enable: The http2_enable of this Listener.
|
426
426
|
:type http2_enable: bool
|
@@ -431,7 +431,7 @@ class Listener:
|
|
431
431
|
def id(self):
|
432
432
|
"""Gets the id of this Listener.
|
433
433
|
|
434
|
-
|
434
|
+
参数解释:监听器ID。
|
435
435
|
|
436
436
|
:return: The id of this Listener.
|
437
437
|
:rtype: str
|
@@ -442,7 +442,7 @@ class Listener:
|
|
442
442
|
def id(self, id):
|
443
443
|
"""Sets the id of this Listener.
|
444
444
|
|
445
|
-
|
445
|
+
参数解释:监听器ID。
|
446
446
|
|
447
447
|
:param id: The id of this Listener.
|
448
448
|
:type id: str
|
@@ -471,7 +471,7 @@ class Listener:
|
|
471
471
|
def loadbalancers(self):
|
472
472
|
"""Gets the loadbalancers of this Listener.
|
473
473
|
|
474
|
-
|
474
|
+
参数解释:监听器所属的负载均衡器的ID列表。 约束限制:一个监听器只支持关联到一个LB。
|
475
475
|
|
476
476
|
:return: The loadbalancers of this Listener.
|
477
477
|
:rtype: list[:class:`huaweicloudsdkelb.v3.LoadBalancerRef`]
|
@@ -482,7 +482,7 @@ class Listener:
|
|
482
482
|
def loadbalancers(self, loadbalancers):
|
483
483
|
"""Sets the loadbalancers of this Listener.
|
484
484
|
|
485
|
-
|
485
|
+
参数解释:监听器所属的负载均衡器的ID列表。 约束限制:一个监听器只支持关联到一个LB。
|
486
486
|
|
487
487
|
:param loadbalancers: The loadbalancers of this Listener.
|
488
488
|
:type loadbalancers: list[:class:`huaweicloudsdkelb.v3.LoadBalancerRef`]
|
@@ -493,7 +493,7 @@ class Listener:
|
|
493
493
|
def name(self):
|
494
494
|
"""Gets the name of this Listener.
|
495
495
|
|
496
|
-
|
496
|
+
参数解释:监听器的名称。 约束限制:若名称为空,则在控制台的监听器列表无法选择并查看监听器详情。
|
497
497
|
|
498
498
|
:return: The name of this Listener.
|
499
499
|
:rtype: str
|
@@ -504,7 +504,7 @@ class Listener:
|
|
504
504
|
def name(self, name):
|
505
505
|
"""Sets the name of this Listener.
|
506
506
|
|
507
|
-
|
507
|
+
参数解释:监听器的名称。 约束限制:若名称为空,则在控制台的监听器列表无法选择并查看监听器详情。
|
508
508
|
|
509
509
|
:param name: The name of this Listener.
|
510
510
|
:type name: str
|
@@ -515,7 +515,7 @@ class Listener:
|
|
515
515
|
def project_id(self):
|
516
516
|
"""Gets the project_id of this Listener.
|
517
517
|
|
518
|
-
|
518
|
+
参数解释:监听器所在的项目ID。
|
519
519
|
|
520
520
|
:return: The project_id of this Listener.
|
521
521
|
:rtype: str
|
@@ -526,7 +526,7 @@ class Listener:
|
|
526
526
|
def project_id(self, project_id):
|
527
527
|
"""Sets the project_id of this Listener.
|
528
528
|
|
529
|
-
|
529
|
+
参数解释:监听器所在的项目ID。
|
530
530
|
|
531
531
|
:param project_id: The project_id of this Listener.
|
532
532
|
:type project_id: str
|
@@ -537,7 +537,7 @@ class Listener:
|
|
537
537
|
def protocol(self):
|
538
538
|
"""Gets the protocol of this Listener.
|
539
539
|
|
540
|
-
|
540
|
+
参数解释:监听器的监听协议。 [取值范围:TCP、UDP、HTTP、HTTPS、TERMINATED_HTTPS、QUIC、TLS。 约束限制: - 共享型LB上的HTTPS监听器只支持设置为TERMINATED_HTTPS, 创建时传入HTTPS将会自动转为TERMINATED_HTTPS。 - 独享型LB上的HTTPS监听器只支持设置为HTTPS,创建时传入TERMINATED_HTTPS将会自动转为HTTPS。 ](tag:hws,hws_hk,ocb,ctc,hcs,g42,tm,cmcc,hk_g42,hws_ocb,hk_vdf,fcs,dt) [取值:TCP、UDP、HTTP、HTTPS。](tag:hcso_dt) [取值:TCP、UDP、IP、HTTP、HTTPS。IP为网关型LB上的监听器独有的协议。](tag:hws_eu) [不支持QUIC。](tag:tm,hws_eu,g42,hk_g42,hcso_dt,dt,dt_test)
|
541
541
|
|
542
542
|
:return: The protocol of this Listener.
|
543
543
|
:rtype: str
|
@@ -548,7 +548,7 @@ class Listener:
|
|
548
548
|
def protocol(self, protocol):
|
549
549
|
"""Sets the protocol of this Listener.
|
550
550
|
|
551
|
-
|
551
|
+
参数解释:监听器的监听协议。 [取值范围:TCP、UDP、HTTP、HTTPS、TERMINATED_HTTPS、QUIC、TLS。 约束限制: - 共享型LB上的HTTPS监听器只支持设置为TERMINATED_HTTPS, 创建时传入HTTPS将会自动转为TERMINATED_HTTPS。 - 独享型LB上的HTTPS监听器只支持设置为HTTPS,创建时传入TERMINATED_HTTPS将会自动转为HTTPS。 ](tag:hws,hws_hk,ocb,ctc,hcs,g42,tm,cmcc,hk_g42,hws_ocb,hk_vdf,fcs,dt) [取值:TCP、UDP、HTTP、HTTPS。](tag:hcso_dt) [取值:TCP、UDP、IP、HTTP、HTTPS。IP为网关型LB上的监听器独有的协议。](tag:hws_eu) [不支持QUIC。](tag:tm,hws_eu,g42,hk_g42,hcso_dt,dt,dt_test)
|
552
552
|
|
553
553
|
:param protocol: The protocol of this Listener.
|
554
554
|
:type protocol: str
|
@@ -559,7 +559,7 @@ class Listener:
|
|
559
559
|
def protocol_port(self):
|
560
560
|
"""Gets the protocol_port of this Listener.
|
561
561
|
|
562
|
-
|
562
|
+
参数解释:监听器的监听端口。 约束限制: - QUIC监听器端口不能是4789,且不能和UDP监听器端口重复。 - 传0表示开启监听端口范围的能力,此时port_ranges为必填字段。 [-不支持QUIC。](tag:tm,hws_eu,g42,hk_g42,hcso_dt,dt,dt_test)
|
563
563
|
|
564
564
|
:return: The protocol_port of this Listener.
|
565
565
|
:rtype: int
|
@@ -570,7 +570,7 @@ class Listener:
|
|
570
570
|
def protocol_port(self, protocol_port):
|
571
571
|
"""Sets the protocol_port of this Listener.
|
572
572
|
|
573
|
-
|
573
|
+
参数解释:监听器的监听端口。 约束限制: - QUIC监听器端口不能是4789,且不能和UDP监听器端口重复。 - 传0表示开启监听端口范围的能力,此时port_ranges为必填字段。 [-不支持QUIC。](tag:tm,hws_eu,g42,hk_g42,hcso_dt,dt,dt_test)
|
574
574
|
|
575
575
|
:param protocol_port: The protocol_port of this Listener.
|
576
576
|
:type protocol_port: int
|
@@ -581,7 +581,7 @@ class Listener:
|
|
581
581
|
def sni_container_refs(self):
|
582
582
|
"""Gets the sni_container_refs of this Listener.
|
583
583
|
|
584
|
-
|
584
|
+
参数解释:监听器使用的SNI证书(带域名的服务器证书)ID列表。 约束限制: - 列表对应的所有SNI证书的域名不允许存在重复。 - 列表对应的所有SNI证书的域名总数不超过50。
|
585
585
|
|
586
586
|
:return: The sni_container_refs of this Listener.
|
587
587
|
:rtype: list[str]
|
@@ -592,7 +592,7 @@ class Listener:
|
|
592
592
|
def sni_container_refs(self, sni_container_refs):
|
593
593
|
"""Sets the sni_container_refs of this Listener.
|
594
594
|
|
595
|
-
|
595
|
+
参数解释:监听器使用的SNI证书(带域名的服务器证书)ID列表。 约束限制: - 列表对应的所有SNI证书的域名不允许存在重复。 - 列表对应的所有SNI证书的域名总数不超过50。
|
596
596
|
|
597
597
|
:param sni_container_refs: The sni_container_refs of this Listener.
|
598
598
|
:type sni_container_refs: list[str]
|
@@ -603,7 +603,7 @@ class Listener:
|
|
603
603
|
def sni_match_algo(self):
|
604
604
|
"""Gets the sni_match_algo of this Listener.
|
605
605
|
|
606
|
-
|
606
|
+
参数解释:监听器使用的SNI证书泛域名匹配方式。 取值范围:longest_suffix表示最长尾缀匹配;wildcard表示标准域名分级匹配。 默认取值:wildcard
|
607
607
|
|
608
608
|
:return: The sni_match_algo of this Listener.
|
609
609
|
:rtype: str
|
@@ -614,7 +614,7 @@ class Listener:
|
|
614
614
|
def sni_match_algo(self, sni_match_algo):
|
615
615
|
"""Sets the sni_match_algo of this Listener.
|
616
616
|
|
617
|
-
|
617
|
+
参数解释:监听器使用的SNI证书泛域名匹配方式。 取值范围:longest_suffix表示最长尾缀匹配;wildcard表示标准域名分级匹配。 默认取值:wildcard
|
618
618
|
|
619
619
|
:param sni_match_algo: The sni_match_algo of this Listener.
|
620
620
|
:type sni_match_algo: str
|
@@ -625,7 +625,7 @@ class Listener:
|
|
625
625
|
def tags(self):
|
626
626
|
"""Gets the tags of this Listener.
|
627
627
|
|
628
|
-
|
628
|
+
参数解释:标签列表。
|
629
629
|
|
630
630
|
:return: The tags of this Listener.
|
631
631
|
:rtype: list[:class:`huaweicloudsdkelb.v3.Tag`]
|
@@ -636,7 +636,7 @@ class Listener:
|
|
636
636
|
def tags(self, tags):
|
637
637
|
"""Sets the tags of this Listener.
|
638
638
|
|
639
|
-
|
639
|
+
参数解释:标签列表。
|
640
640
|
|
641
641
|
:param tags: The tags of this Listener.
|
642
642
|
:type tags: list[:class:`huaweicloudsdkelb.v3.Tag`]
|
@@ -647,7 +647,7 @@ class Listener:
|
|
647
647
|
def updated_at(self):
|
648
648
|
"""Gets the updated_at of this Listener.
|
649
649
|
|
650
|
-
|
650
|
+
参数解释:监听器的更新时间。 取值范围: 格式:yyyy-MM-dd'T'HH:mm:ss'Z',如:2021-07-30T12:03:44Z
|
651
651
|
|
652
652
|
:return: The updated_at of this Listener.
|
653
653
|
:rtype: str
|
@@ -658,7 +658,7 @@ class Listener:
|
|
658
658
|
def updated_at(self, updated_at):
|
659
659
|
"""Sets the updated_at of this Listener.
|
660
660
|
|
661
|
-
|
661
|
+
参数解释:监听器的更新时间。 取值范围: 格式:yyyy-MM-dd'T'HH:mm:ss'Z',如:2021-07-30T12:03:44Z
|
662
662
|
|
663
663
|
:param updated_at: The updated_at of this Listener.
|
664
664
|
:type updated_at: str
|
@@ -669,7 +669,7 @@ class Listener:
|
|
669
669
|
def tls_ciphers_policy(self):
|
670
670
|
"""Gets the tls_ciphers_policy of this Listener.
|
671
671
|
|
672
|
-
|
672
|
+
参数解释:监听器使用的安全策略。 [取值范围: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、tls-1-2-strict-no-cbc,默认:tls-1-0。 ](tag:hws,hws_hk,ocb,tlf,ctc,hcso,sbc,tm,cmcc,dt) [取值范围:tls-1-0、tls-1-1、tls-1-2、 tls-1-2-strict,默认:tls-1-0。](tag:hws_eu,g42,hk_g42,hcso_dt) [约束限制: - 仅对HTTPS协议类型的监听器且关联LB为独享型时有效。 - QUIC监听器不支持该字段。 - 若同时设置了security_policy_id和tls_ciphers_policy,则仅security_policy_id生效。 - 加密套件的优先顺序为ecc套件、rsa套件、tls1.3协议的套件(即支持ecc又支持rsa) ](tag:hws,hws_hk,hws_eu,ocb,tlf,ctc,hcso,sbc,g42,tm,cmcc,hk-g42,dt) [约束限制: - 仅对HTTPS协议类型的监听器有效](tag:hcso_dt) [不支持tls1.3协议的套件。](tag:tm,hws_eu,g42,hk_g42) [不支持QUIC。](tag:tm,dt,dt_test)
|
673
673
|
|
674
674
|
:return: The tls_ciphers_policy of this Listener.
|
675
675
|
:rtype: str
|
@@ -680,7 +680,7 @@ class Listener:
|
|
680
680
|
def tls_ciphers_policy(self, tls_ciphers_policy):
|
681
681
|
"""Sets the tls_ciphers_policy of this Listener.
|
682
682
|
|
683
|
-
|
683
|
+
参数解释:监听器使用的安全策略。 [取值范围: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、tls-1-2-strict-no-cbc,默认:tls-1-0。 ](tag:hws,hws_hk,ocb,tlf,ctc,hcso,sbc,tm,cmcc,dt) [取值范围:tls-1-0、tls-1-1、tls-1-2、 tls-1-2-strict,默认:tls-1-0。](tag:hws_eu,g42,hk_g42,hcso_dt) [约束限制: - 仅对HTTPS协议类型的监听器且关联LB为独享型时有效。 - QUIC监听器不支持该字段。 - 若同时设置了security_policy_id和tls_ciphers_policy,则仅security_policy_id生效。 - 加密套件的优先顺序为ecc套件、rsa套件、tls1.3协议的套件(即支持ecc又支持rsa) ](tag:hws,hws_hk,hws_eu,ocb,tlf,ctc,hcso,sbc,g42,tm,cmcc,hk-g42,dt) [约束限制: - 仅对HTTPS协议类型的监听器有效](tag:hcso_dt) [不支持tls1.3协议的套件。](tag:tm,hws_eu,g42,hk_g42) [不支持QUIC。](tag:tm,dt,dt_test)
|
684
684
|
|
685
685
|
:param tls_ciphers_policy: The tls_ciphers_policy of this Listener.
|
686
686
|
:type tls_ciphers_policy: str
|
@@ -691,7 +691,7 @@ class Listener:
|
|
691
691
|
def security_policy_id(self):
|
692
692
|
"""Gets the security_policy_id of this Listener.
|
693
693
|
|
694
|
-
|
694
|
+
参数解释:自定义安全策略的ID。 [约束限制: - 仅对HTTPS协议类型的监听器且关联LB为独享型时有效。 - 若同时设置了security_policy_id和tls_ciphers_policy,则仅security_policy_id生效。 - 加密套件的优先顺序为ecc套件、rsa套件、tls1.3协议的套件(即支持ecc又支持rsa) ](tag:hws,hws_hk,hws_eu,ocb,ctc,hcso,g42,tm,cmcc,hk-g42,dt) [约束限制: - 仅对HTTPS协议类型的监听器有效](tag:hcso_dt) [不支持tls1.3协议的套件。](tag:tm,hws_eu,g42,hk_g42)
|
695
695
|
|
696
696
|
:return: The security_policy_id of this Listener.
|
697
697
|
:rtype: str
|
@@ -702,7 +702,7 @@ class Listener:
|
|
702
702
|
def security_policy_id(self, security_policy_id):
|
703
703
|
"""Sets the security_policy_id of this Listener.
|
704
704
|
|
705
|
-
|
705
|
+
参数解释:自定义安全策略的ID。 [约束限制: - 仅对HTTPS协议类型的监听器且关联LB为独享型时有效。 - 若同时设置了security_policy_id和tls_ciphers_policy,则仅security_policy_id生效。 - 加密套件的优先顺序为ecc套件、rsa套件、tls1.3协议的套件(即支持ecc又支持rsa) ](tag:hws,hws_hk,hws_eu,ocb,ctc,hcso,g42,tm,cmcc,hk-g42,dt) [约束限制: - 仅对HTTPS协议类型的监听器有效](tag:hcso_dt) [不支持tls1.3协议的套件。](tag:tm,hws_eu,g42,hk_g42)
|
706
706
|
|
707
707
|
:param security_policy_id: The security_policy_id of this Listener.
|
708
708
|
:type security_policy_id: str
|
@@ -713,7 +713,7 @@ class Listener:
|
|
713
713
|
def enable_member_retry(self):
|
714
714
|
"""Gets the enable_member_retry of this Listener.
|
715
715
|
|
716
|
-
|
716
|
+
参数解释:是否开启后端服务器的重试。 [约束限制: - 若关联是共享型LB,仅在protocol为HTTP、TERMINATED_HTTPS时才能传入该字段。 - 若关联是独享型LB,仅在protocol为HTTP、HTTPS和QUIC时才能传入该字段。 ](tag:hws,hws_hk,ocb,ctc,hcs,g42,tm,cmcc,hk_g42,hws_ocb,hk_vdf,fcs,dt) [约束限制: - 仅在protocol为HTTP、HTTPS时才能传入该字段。](tag:hws_eu,hcso_dt) 取值范围:true 开启重试,false 不开启重试。 默认取值:true。 [不支持QUIC。](tag:tm,dt,dt_test)
|
717
717
|
|
718
718
|
:return: The enable_member_retry of this Listener.
|
719
719
|
:rtype: bool
|
@@ -724,7 +724,7 @@ class Listener:
|
|
724
724
|
def enable_member_retry(self, enable_member_retry):
|
725
725
|
"""Sets the enable_member_retry of this Listener.
|
726
726
|
|
727
|
-
|
727
|
+
参数解释:是否开启后端服务器的重试。 [约束限制: - 若关联是共享型LB,仅在protocol为HTTP、TERMINATED_HTTPS时才能传入该字段。 - 若关联是独享型LB,仅在protocol为HTTP、HTTPS和QUIC时才能传入该字段。 ](tag:hws,hws_hk,ocb,ctc,hcs,g42,tm,cmcc,hk_g42,hws_ocb,hk_vdf,fcs,dt) [约束限制: - 仅在protocol为HTTP、HTTPS时才能传入该字段。](tag:hws_eu,hcso_dt) 取值范围:true 开启重试,false 不开启重试。 默认取值:true。 [不支持QUIC。](tag:tm,dt,dt_test)
|
728
728
|
|
729
729
|
:param enable_member_retry: The enable_member_retry of this Listener.
|
730
730
|
:type enable_member_retry: bool
|
@@ -735,7 +735,7 @@ class Listener:
|
|
735
735
|
def keepalive_timeout(self):
|
736
736
|
"""Gets the keepalive_timeout of this Listener.
|
737
737
|
|
738
|
-
|
738
|
+
参数解释:客户端连接空闲超时时间。在超过keepalive_timeout时长一直没有请求, 负载均衡会暂时中断当前连接,直到下一次请求时重新建立新的连接。 约束限制:共享型实例的UDP监听器不支持此字段。 取值范围: - TCP监听器[和IP监听器](tag:hws_eu):10-4000s,默认值为300s。 - 若为HTTP/HTTPS/TERMINATED_HTTPS监听器,取值范围为(0-4000s)默认值为60s。
|
739
739
|
|
740
740
|
:return: The keepalive_timeout of this Listener.
|
741
741
|
:rtype: int
|
@@ -746,7 +746,7 @@ class Listener:
|
|
746
746
|
def keepalive_timeout(self, keepalive_timeout):
|
747
747
|
"""Sets the keepalive_timeout of this Listener.
|
748
748
|
|
749
|
-
|
749
|
+
参数解释:客户端连接空闲超时时间。在超过keepalive_timeout时长一直没有请求, 负载均衡会暂时中断当前连接,直到下一次请求时重新建立新的连接。 约束限制:共享型实例的UDP监听器不支持此字段。 取值范围: - TCP监听器[和IP监听器](tag:hws_eu):10-4000s,默认值为300s。 - 若为HTTP/HTTPS/TERMINATED_HTTPS监听器,取值范围为(0-4000s)默认值为60s。
|
750
750
|
|
751
751
|
:param keepalive_timeout: The keepalive_timeout of this Listener.
|
752
752
|
:type keepalive_timeout: int
|
@@ -757,7 +757,7 @@ class Listener:
|
|
757
757
|
def client_timeout(self):
|
758
758
|
"""Gets the client_timeout of this Listener.
|
759
759
|
|
760
|
-
|
760
|
+
参数解释:等待客户端请求超时时间,包括两种情况: - 读取整个客户端请求头的超时时长:如果客户端未在超时时长内发送完整个请求头,则请求将被中断 - 两个连续body体的数据包到达LB的时间间隔,超出client_timeout将会断开连接。 约束限制:仅协议为HTTP/HTTPS的监听器支持该字段。 取值范围:1-3600s 默认取值:60s。
|
761
761
|
|
762
762
|
:return: The client_timeout of this Listener.
|
763
763
|
:rtype: int
|
@@ -768,7 +768,7 @@ class Listener:
|
|
768
768
|
def client_timeout(self, client_timeout):
|
769
769
|
"""Sets the client_timeout of this Listener.
|
770
770
|
|
771
|
-
|
771
|
+
参数解释:等待客户端请求超时时间,包括两种情况: - 读取整个客户端请求头的超时时长:如果客户端未在超时时长内发送完整个请求头,则请求将被中断 - 两个连续body体的数据包到达LB的时间间隔,超出client_timeout将会断开连接。 约束限制:仅协议为HTTP/HTTPS的监听器支持该字段。 取值范围:1-3600s 默认取值:60s。
|
772
772
|
|
773
773
|
:param client_timeout: The client_timeout of this Listener.
|
774
774
|
:type client_timeout: int
|
@@ -779,7 +779,7 @@ class Listener:
|
|
779
779
|
def member_timeout(self):
|
780
780
|
"""Gets the member_timeout of this Listener.
|
781
781
|
|
782
|
-
|
782
|
+
参数解释:等待后端服务器响应超时时间。请求转发后端服务器后,在等待超时member_timeout时长没有响应,负载均衡将终止等待,并返回HTTP504错误码。 约束限制:仅支持协议为HTTP/HTTPS的监听器。 取值范围:1-3600s 默认取值:60s。
|
783
783
|
|
784
784
|
:return: The member_timeout of this Listener.
|
785
785
|
:rtype: int
|
@@ -790,7 +790,7 @@ class Listener:
|
|
790
790
|
def member_timeout(self, member_timeout):
|
791
791
|
"""Sets the member_timeout of this Listener.
|
792
792
|
|
793
|
-
|
793
|
+
参数解释:等待后端服务器响应超时时间。请求转发后端服务器后,在等待超时member_timeout时长没有响应,负载均衡将终止等待,并返回HTTP504错误码。 约束限制:仅支持协议为HTTP/HTTPS的监听器。 取值范围:1-3600s 默认取值:60s。
|
794
794
|
|
795
795
|
:param member_timeout: The member_timeout of this Listener.
|
796
796
|
:type member_timeout: int
|
@@ -819,7 +819,7 @@ class Listener:
|
|
819
819
|
def transparent_client_ip_enable(self):
|
820
820
|
"""Gets the transparent_client_ip_enable of this Listener.
|
821
821
|
|
822
|
-
|
822
|
+
参数解释:是否透传客户端IP地址。开启后客户端IP地址将透传到后端服务器。 [仅作用于共享型LB的TCP/UDP监听器。 约束限制: - 开启特性后,ELB和后端服务器之间直接使用真实的IP访问,需要确保已正确设置服务器的安全组以及访问控制策略。 - 开启特性后,不支持同一台服务器既作为后端服务器又作为客户端的场景。 - 开启特性后,不支持变更后端服务器规格。 ](tag:hws,hws_hk,ocb,ctc,hcs,g42,tm,cmcc,hk_g42,hws_ocb,hk_vdf,fcs,dt) 取值范围: - 共享型LB的TCP/UDP监听器可设置为true或false,不传默认为false。 - 共享型LB的HTTP/HTTPS监听器只支持设置为true,不传默认为true。 - 独享型负载均衡器所有协议的监听器只支持设置为true,不传默认为true。 [只设支持置为true,不传默认为true。](tag:hws_eu,hcso_dt)
|
823
823
|
|
824
824
|
:return: The transparent_client_ip_enable of this Listener.
|
825
825
|
:rtype: bool
|
@@ -830,7 +830,7 @@ class Listener:
|
|
830
830
|
def transparent_client_ip_enable(self, transparent_client_ip_enable):
|
831
831
|
"""Sets the transparent_client_ip_enable of this Listener.
|
832
832
|
|
833
|
-
|
833
|
+
参数解释:是否透传客户端IP地址。开启后客户端IP地址将透传到后端服务器。 [仅作用于共享型LB的TCP/UDP监听器。 约束限制: - 开启特性后,ELB和后端服务器之间直接使用真实的IP访问,需要确保已正确设置服务器的安全组以及访问控制策略。 - 开启特性后,不支持同一台服务器既作为后端服务器又作为客户端的场景。 - 开启特性后,不支持变更后端服务器规格。 ](tag:hws,hws_hk,ocb,ctc,hcs,g42,tm,cmcc,hk_g42,hws_ocb,hk_vdf,fcs,dt) 取值范围: - 共享型LB的TCP/UDP监听器可设置为true或false,不传默认为false。 - 共享型LB的HTTP/HTTPS监听器只支持设置为true,不传默认为true。 - 独享型负载均衡器所有协议的监听器只支持设置为true,不传默认为true。 [只设支持置为true,不传默认为true。](tag:hws_eu,hcso_dt)
|
834
834
|
|
835
835
|
:param transparent_client_ip_enable: The transparent_client_ip_enable of this Listener.
|
836
836
|
:type transparent_client_ip_enable: bool
|
@@ -841,7 +841,7 @@ class Listener:
|
|
841
841
|
def proxy_protocol_enable(self):
|
842
842
|
"""Gets the proxy_protocol_enable of this Listener.
|
843
843
|
|
844
|
-
|
844
|
+
参数解释:是否开启proxy_protocol。仅TLS监听器可指定,其他协议的监听器该字段不生效,proxy_protocol不开启。
|
845
845
|
|
846
846
|
:return: The proxy_protocol_enable of this Listener.
|
847
847
|
:rtype: bool
|
@@ -852,7 +852,7 @@ class Listener:
|
|
852
852
|
def proxy_protocol_enable(self, proxy_protocol_enable):
|
853
853
|
"""Sets the proxy_protocol_enable of this Listener.
|
854
854
|
|
855
|
-
|
855
|
+
参数解释:是否开启proxy_protocol。仅TLS监听器可指定,其他协议的监听器该字段不生效,proxy_protocol不开启。
|
856
856
|
|
857
857
|
:param proxy_protocol_enable: The proxy_protocol_enable of this Listener.
|
858
858
|
:type proxy_protocol_enable: bool
|
@@ -863,7 +863,7 @@ class Listener:
|
|
863
863
|
def enhance_l7policy_enable(self):
|
864
864
|
"""Gets the enhance_l7policy_enable of this Listener.
|
865
865
|
|
866
|
-
|
866
|
+
参数解释:是否开启高级转发策略功能。开启高级转发策略后,支持更灵活的转发策略和转发规则设置。 开启后支持如下场景: - 转发策略的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字段。 取值范围:true开启,false不开启。 默认取值:false。 [荷兰region不支持该字段,请勿使用。](tag:dt,dt_test)
|
867
867
|
|
868
868
|
:return: The enhance_l7policy_enable of this Listener.
|
869
869
|
:rtype: bool
|
@@ -874,7 +874,7 @@ class Listener:
|
|
874
874
|
def enhance_l7policy_enable(self, enhance_l7policy_enable):
|
875
875
|
"""Sets the enhance_l7policy_enable of this Listener.
|
876
876
|
|
877
|
-
|
877
|
+
参数解释:是否开启高级转发策略功能。开启高级转发策略后,支持更灵活的转发策略和转发规则设置。 开启后支持如下场景: - 转发策略的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字段。 取值范围:true开启,false不开启。 默认取值:false。 [荷兰region不支持该字段,请勿使用。](tag:dt,dt_test)
|
878
878
|
|
879
879
|
:param enhance_l7policy_enable: The enhance_l7policy_enable of this Listener.
|
880
880
|
:type enhance_l7policy_enable: bool
|
@@ -903,7 +903,7 @@ class Listener:
|
|
903
903
|
def protection_status(self):
|
904
904
|
"""Gets the protection_status of this Listener.
|
905
905
|
|
906
|
-
|
906
|
+
参数解释:修改保护状态, 取值范围: - nonProtection: 不保护,默认值为nonProtection - consoleProtection: 控制台修改保护
|
907
907
|
|
908
908
|
:return: The protection_status of this Listener.
|
909
909
|
:rtype: str
|
@@ -914,7 +914,7 @@ class Listener:
|
|
914
914
|
def protection_status(self, protection_status):
|
915
915
|
"""Sets the protection_status of this Listener.
|
916
916
|
|
917
|
-
|
917
|
+
参数解释:修改保护状态, 取值范围: - nonProtection: 不保护,默认值为nonProtection - consoleProtection: 控制台修改保护
|
918
918
|
|
919
919
|
:param protection_status: The protection_status of this Listener.
|
920
920
|
:type protection_status: str
|
@@ -925,7 +925,7 @@ class Listener:
|
|
925
925
|
def protection_reason(self):
|
926
926
|
"""Gets the protection_reason of this Listener.
|
927
927
|
|
928
|
-
|
928
|
+
参数解释:设置保护的原因。 约束限制: 仅当protection_status为consoleProtection时有效。
|
929
929
|
|
930
930
|
:return: The protection_reason of this Listener.
|
931
931
|
:rtype: str
|
@@ -936,7 +936,7 @@ class Listener:
|
|
936
936
|
def protection_reason(self, protection_reason):
|
937
937
|
"""Sets the protection_reason of this Listener.
|
938
938
|
|
939
|
-
|
939
|
+
参数解释:设置保护的原因。 约束限制: 仅当protection_status为consoleProtection时有效。
|
940
940
|
|
941
941
|
:param protection_reason: The protection_reason of this Listener.
|
942
942
|
:type protection_reason: str
|
@@ -947,7 +947,7 @@ class Listener:
|
|
947
947
|
def gzip_enable(self):
|
948
948
|
"""Gets the gzip_enable of this Listener.
|
949
949
|
|
950
|
-
ELB是否开启gzip
|
950
|
+
参数解释:ELB是否开启gzip压缩。 [约束限制:仅HTTP/HTTPS类型监听器支持配置。](tag:tm,hws_eu,g42,hk_g42,hcso_dt,dt,dt_test) [约束限制:仅HTTP/HTTPS/QUIC类型监听器支持配置。](tag:hws,hws_hk,hws_test,hcs,hcs_sm,hcso,hk_vdf,fcs,fcs_vm,mix,ocb,ctc,cmcc,sbc,hws_ocb,hk_sbc) 默认取值:false
|
951
951
|
|
952
952
|
:return: The gzip_enable of this Listener.
|
953
953
|
:rtype: bool
|
@@ -958,7 +958,7 @@ class Listener:
|
|
958
958
|
def gzip_enable(self, gzip_enable):
|
959
959
|
"""Sets the gzip_enable of this Listener.
|
960
960
|
|
961
|
-
ELB是否开启gzip
|
961
|
+
参数解释:ELB是否开启gzip压缩。 [约束限制:仅HTTP/HTTPS类型监听器支持配置。](tag:tm,hws_eu,g42,hk_g42,hcso_dt,dt,dt_test) [约束限制:仅HTTP/HTTPS/QUIC类型监听器支持配置。](tag:hws,hws_hk,hws_test,hcs,hcs_sm,hcso,hk_vdf,fcs,fcs_vm,mix,ocb,ctc,cmcc,sbc,hws_ocb,hk_sbc) 默认取值:false
|
962
962
|
|
963
963
|
:param gzip_enable: The gzip_enable of this Listener.
|
964
964
|
:type gzip_enable: bool
|
@@ -969,7 +969,7 @@ class Listener:
|
|
969
969
|
def port_ranges(self):
|
970
970
|
"""Gets the port_ranges of this Listener.
|
971
971
|
|
972
|
-
|
972
|
+
参数解释:端口监听范围(闭区间)。 约束限制: - 最多指定10个端口组,每个组范围不可有重叠部分 - 仅当protocol_port为0时可以传入。
|
973
973
|
|
974
974
|
:return: The port_ranges of this Listener.
|
975
975
|
:rtype: list[:class:`huaweicloudsdkelb.v3.PortRange`]
|
@@ -980,7 +980,7 @@ class Listener:
|
|
980
980
|
def port_ranges(self, port_ranges):
|
981
981
|
"""Sets the port_ranges of this Listener.
|
982
982
|
|
983
|
-
|
983
|
+
参数解释:端口监听范围(闭区间)。 约束限制: - 最多指定10个端口组,每个组范围不可有重叠部分 - 仅当protocol_port为0时可以传入。
|
984
984
|
|
985
985
|
:param port_ranges: The port_ranges of this Listener.
|
986
986
|
:type port_ranges: list[:class:`huaweicloudsdkelb.v3.PortRange`]
|
@@ -991,7 +991,7 @@ class Listener:
|
|
991
991
|
def ssl_early_data_enable(self):
|
992
992
|
"""Gets the ssl_early_data_enable of this Listener.
|
993
993
|
|
994
|
-
|
994
|
+
参数解释:监听器0-RTT能力开关 约束限制:仅HTTPS类型监听器支持配置,需要依赖TLSv1.3安全策略协议。 默认取值:false。
|
995
995
|
|
996
996
|
:return: The ssl_early_data_enable of this Listener.
|
997
997
|
:rtype: bool
|
@@ -1002,7 +1002,7 @@ class Listener:
|
|
1002
1002
|
def ssl_early_data_enable(self, ssl_early_data_enable):
|
1003
1003
|
"""Sets the ssl_early_data_enable of this Listener.
|
1004
1004
|
|
1005
|
-
|
1005
|
+
参数解释:监听器0-RTT能力开关 约束限制:仅HTTPS类型监听器支持配置,需要依赖TLSv1.3安全策略协议。 默认取值:false。
|
1006
1006
|
|
1007
1007
|
:param ssl_early_data_enable: The ssl_early_data_enable of this Listener.
|
1008
1008
|
:type ssl_early_data_enable: bool
|