Updating a Listener¶
Function¶
This API is used to update a listener.
Constraints¶
If the provisioning status of the load balancer that the listener is added to is not ACTIVE, the listener cannot be updated. Only the administrator can specify connection_limit.
URI¶
PUT /v3/{project_id}/elb/listeners/{listener_id}
Parameter | Mandatory | Type | Description |
---|---|---|---|
listener_id | Yes | String | Specifies the listener ID. |
project_id | Yes | String | Specifies the tenant ID. |
Request Parameters¶
Parameter | Mandatory | Type | Description |
---|---|---|---|
X-Auth-Token | Yes | String | Specifies the token used for IAM authentication. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
listener | Yes | UpdateListenerOption object | Specifies the listener. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
admin_state_up | No | Boolean | Specifies the administrative status of the listener. And the value can only be true. This parameter is unsupported. Please do not use it. |
client_ca_tls_container_ref | No | String | Specifies the ID of the CA certificate used by the listener. |
default_pool_id | No | String | Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server. Minimum: 1 Maximum: 36 |
default_tls_container_ref | No | String | Specifies the ID of the server certificate used by the listener. |
description | No | String | Provides supplementary information about the listener. Minimum: 1 Maximum: 255 |
http2_enable | No | Boolean | Specifies whether to use HTTP/2. This parameter is available only for HTTPS listeners. If you configure this parameter for other types of listeners, it will not take effect. Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default. Default: true |
insert_headers | No | ListenerInsertHeaders object | Specifies the HTTP header fields. |
name | No | String | Specifies the listener name. Minimum: 1 Maximum: 255 |
sni_container_refs | No | Array of strings | Lists the IDs of SNI certificates (server certificates with domain names) used by the listener. Each SNI certificate can have up to 30 domain names, and each domain name in the SNI certificate must be unique. This parameter will be ignored and an empty array will be returned if the listener's protocol is not HTTPS. |
tls_ciphers_policy | No | String | Specifies the security policy used by the listener. This parameter is available only for HTTPS listeners. The default value is tls-1-0. An error will be returned if the protocol of the listener is not HTTPS. Value options:
|
enable_member_retry | No | Boolean | Specifies whether to enable health check retries for backend servers. This parameter is unsupported. Please do not use it. Default: false |
member_timeout | No | Integer | Specifies the timeout duration for waiting for a request from a backend server, in seconds. This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60. |
client_timeout | No | Integer | Specifies the timeout duration for waiting for a request from a client, in seconds. This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60. |
keepalive_timeout | No | Integer | Specifies the idle timeout duration, in seconds.
|
ipgroup | No | UpdateListenerIpGroupOption object | Specifies the IP address group associated with the listener. The value can be null or an empty JSON structure, indicating that no IP address group is associated with the listener. ipgroup_id is also required if you want to associate an IP address group with the listener. This parameter is unsupported. Please do not use it. |
transparent_client_ip_enable | No | Boolean | Specifies whether to pass source IP addresses of the clients to backend servers. The value can only be true for all types of listeners. If this parameter is not passed, the default value is true. |
enhance_l7policy_enable | No | Boolean | Specifies whether to enable advanced forwarding. The value can be true or false (default).
The following parameters will be available only when advanced forwarding is enabled:
For details, see the descriptions in the APIs of forwarding policies and forwarding rules. This parameter is unsupported. Please do not use it. |
security_policy_id | No | String | Specifies the ID of the custom security policy. Custom security policies take effect only for dedicated load balancers. If both security_policy_id and tls_ciphers_policy are passed, only security_policy_id will take effect. This parameter is unsupported. Please do not use it. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
X-Forwarded-ELB-IP | No | Boolean | Specifies whether to transparently transmit the load balancer EIP to backend servers. If X-Forwarded-ELB-IP is set to true, the load balancer EIP will be stored in the HTTP header and passed to backend servers. Default: false |
X-Forwarded-Port | No | Boolean | Specifies whether to transparently transmit the listening port of the load balancer to backend servers. If X-Forwarded-Port is set to true, the listening port of the load balancer will be stored in the HTTP header and passed to backend servers. Default: false |
X-Forwarded-For-Port | No | Boolean | Specifies whether to transparently transmit the source port of the client to backend servers. If X-Forwarded-For-Port is set to true, the source port of the client will be stored in the HTTP header and passed to backend servers. Default: false |
X-Forwarded-Host | Yes | Boolean | Specifies whether to rewrite the X-Forwarded-Host header. If X-Forwarded-Host is set to true, X-Forwarded-Host in the request header from the clients can be set to Host in the request header sent from the load balancer to backend servers. Default: true |
Parameter | Mandatory | Type | Description |
---|---|---|---|
ipgroup_id | No | String | Specifies the ID of the IP address group associated with the listener.
IP address groups are not supported for now. |
enable_ipgroup | No | Boolean | Specifies whether access control is enabled.
A listener with access control enabled can be directly deleted. |
type | No | String | Specifies how access to the listener is controlled.
|
Response Parameters¶
Status code: 200
Parameter | Type | Description |
---|---|---|
request_id | String | Specifies the request ID. The value is automatically generated. |
listener | Listener object | Specifies the listener. |
Parameter | Type | Description |
---|---|---|
admin_state_up | Boolean | Specifies the administrative status of the listener. And the value can only be true. This parameter is unsupported. Please do not use it. Default: true |
client_ca_tls_container_ref | String | Specifies the ID of the CA certificate used by the listener. |
connection_limit | Integer | Specifies the maximum number of connections. The default value is -1. This parameter is unsupported. Please do not use it. |
created_at | String | Specifies the time when the listener was created. |
default_pool_id | String | Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server. |
default_tls_container_ref | String | Specifies the ID of the server certificate used by the listener. |
description | String | Provides supplementary information about the listener. |
http2_enable | Boolean | Specifies whether to use HTTP/2. This parameter is available only for HTTPS listeners. If you configure this parameter for other types of listeners, it will not take effect. Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default. Default: true |
id | String | Specifies the listener ID. |
insert_headers | ListenerInsertHeaders object | Specifies the HTTP header fields. |
loadbalancers | Array of LoadBalancerRef objects | Specifies the ID of the load balancer that the listener is added to. |
name | String | Specifies the listener name. |
project_id | String | Specifies the ID of the project where the listener is used. |
protocol | String | Specifies the protocol used by the listener. |
protocol_port | Integer | Specifies the port used by the listener. Minimum: 1 Maximum: 65535 |
sni_container_refs | Array of strings | Lists the IDs of SNI certificates (server certificates with domain names) used by the listener. Each SNI certificate can have up to 30 domain names, and each domain name in the SNI certificate must be unique. This parameter will be ignored and an empty array will be returned if the listener's protocol is not HTTPS. |
tags | Array of Tag objects | Lists the tags. |
updated_at | String | Specifies the time when the listener was updated. |
tls_ciphers_policy | String | Specifies the security policy used by the listener. This parameter is available only for HTTPS listeners. The value can be tls-1-0, tls-1-1, tls-1-2, or tls-1-2-strict, and the default value is tls-1-0. |
enable_member_retry | Boolean | Specifies whether to enable health check retries for backend servers. This parameter is available only for HTTP and HTTPS listeners. |
keepalive_timeout | Integer | Specifies the idle timeout duration, in seconds.
|
client_timeout | Integer | Specifies the timeout duration for waiting for a request from a client, in seconds. This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60. |
member_timeout | Integer | Specifies the timeout duration for waiting for a request from a backend server, in seconds. This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60. |
ipgroup | ListenerIpGroup object | Specifies the IP address group associated with the listener. This parameter is unsupported. Please do not use it. |
transparent_client_ip_enable | Boolean | Specifies whether to pass source IP addresses of the clients to backend servers. The value can only be true for all types of listeners. If this parameter is not passed, the default value is true. |
enhance_l7policy_enable | Boolean | Specifies whether to enable advanced forwarding. The value can be true or false (default).
The following parameters will be available only when advanced forwarding is enabled:
For details, see the descriptions in the APIs of forwarding policies and forwarding rules. This parameter is unsupported. Please do not use it. |
security_policy_id | String | Specifies the ID of the custom security policy. Custom security policies take effect only for dedicated load balancers. If both security_policy_id and tls_ciphers_policy are passed, only security_policy_id will take effect. This parameter is unsupported. Please do not use it. |
Parameter | Type | Description |
---|---|---|
X-Forwarded-ELB-IP | Boolean | Specifies whether to transparently transmit the load balancer EIP to backend servers. If X-Forwarded-ELB-IP is set to true, the load balancer EIP will be stored in the HTTP header and passed to backend servers. Default: false |
X-Forwarded-Port | Boolean | Specifies whether to transparently transmit the listening port of the load balancer to backend servers. If X-Forwarded-Port is set to true, the listening port of the load balancer will be stored in the HTTP header and passed to backend servers. Default: false |
X-Forwarded-For-Port | Boolean | Specifies whether to transparently transmit the source port of the client to backend servers. If X-Forwarded-For-Port is set to true, the source port of the client will be stored in the HTTP header and passed to backend servers. Default: false |
X-Forwarded-Host | Boolean | Specifies whether to rewrite the X-Forwarded-Host header. If X-Forwarded-Host is set to true, X-Forwarded-Host in the request header from the clients can be set to Host in the request header sent from the load balancer to backend servers. Default: true |
Parameter | Type | Description |
---|---|---|
id | String | Specifies the load balancer ID. |
Parameter | Type | Description |
---|---|---|
key | String | Specifies the tag key. |
value | String | Specifies the tag value. |
Parameter | Type | Description |
---|---|---|
ipgroup_id | String | Specifies the ID of the IP address group associated with the listener.
|
enable_ipgroup | Boolean | Specifies whether to enable access control.
A listener with access control enabled can be directly deleted. |
type | String | Specifies how access to the listener is controlled.
|
Example Requests¶
PUT
https://{elb_endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/listeners/0b11747a-b139-492f-9692-2df0b1c87193
{
"listener" : {
"description" : "My listener update.",
"name" : "listener-1",
"http2_enable" : true
}
}
Example Responses¶
Status code: 200
Successful request.
{
"listener" : {
"id" : "e2baad06-8095-4159-a14e-d1f0137bac06",
"name" : "listener-1",
"protocol_port" : 77,
"protocol" : "HTTP",
"description" : "My listener update.",
"default_tls_container_ref" : null,
"admin_state_up" : true,
"loadbalancers" : [ {
"id" : "c285bc7b-56d5-43bd-9589-075ee0a5c777"
} ],
"client_ca_tls_container_ref" : null,
"project_id" : "060576782980d5762f9ec014dd2f1148",
"sni_container_refs" : [ ],
"connection_limit" : -1,
"default_pool_id" : "61609d20-5230-4b72-8274-46212bbf317c",
"tls_ciphers_policy" : null,
"security_policy_id" : null,
"tags" : [ ],
"created_at" : "2020-07-28T11:35:21Z",
"updated_at" : "2020-07-28T11:35:21Z",
"http2_enable" : true,
"insert_headers" : {
"X-Forwarded-ELB-IP" : false,
"X-Forwarded-Host" : true,
"X-Forwarded-For-Port" : false,
"X-Forwarded-Port" : false
},
"member_timeout" : 60,
"client_timeout" : 60,
"keepalive_timeout" : 60,
"ipgroup" : null,
"enable_member_retry" : true,
"transparent_client_ip_enable" : true,
"enhance_l7policy_enable" : false
},
"request_id" : "619dc40f7ec73c0f13b5b5127904b71e"
}
Status Codes¶
Status Code | Description |
---|---|
200 | Successful request. |
Error Codes¶
See Error Codes.