Updated on 2022-01-25 GMT+08:00

Updating a Listener

Function

This API is used to update a listener, such as listener name, description, associated backend server groups, and server certificates.

Constraints

  • If the provisioning status of the associated load balancer is not ACTIVE, the listener cannot be updated.
  • Only the administrator can specify connection_limit.
  • The default_pool_id parameter has the following constraints:
    • Its value cannot be the ID of any backend server group of other listeners.
    • Its value cannot be the ID of any backend server group associated with the forwarding policies set for other listeners.
  • The relationships between the protocol used by the listener and the protocol of the backend server group are as follows:
    • When the protocol used by the listener is TCP, the protocol of the backend server group must be TCP.
    • When the protocol used by the listener is UDP, the backend server group protocol must be UDP.
    • When the protocol used by the listener is HTTP or TERMINATED_HTTPS, the protocol of the backend server group must be HTTP.

URI

PUT /v2/{project_id}/elb/listeners/{listener_id}

Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

listener_id

Yes

String

Specifies the listener ID.

Request

Table 2 Parameter description

Parameter

Mandatory

Type

Description

listener

Yes

Object

Specifies the listener. For details, see Table 3.

Table 3 listener parameter description

Parameter

Mandatory

Type

Description

name

No

String

Specifies the listener name.

The value contains a maximum of 255 characters.

description

No

String

Provides supplementary information about the listener.

The value contains a maximum of 255 characters.

connection_limit

No

Integer

Specifies the maximum number of connections.

The value ranges from -1 to 2147483647.

This parameter is reserved. Only the administrator can specify the maximum number of connections.

http2_enable

No

Boolean

Specifies whether to use HTTP/2.

The value can be true or false.

  • true: HTTP/2 is used.
  • false: HTTP/2 is not used.

This parameter is valid only when the protocol used by the listener is set to TERMINATED_HTTPS.

default_pool_id

No

String

Specifies the ID of the associated backend server group.

If a request does not match the forwarding policy, the request is forwarded to the default backend server group for processing. If the value is null, the listener has no default backend server group.

The default_pool_id parameter has the following constraints:
  • Its value cannot be the ID of any backend server group of other listeners.
  • Its value cannot be the ID of any backend server group associated with the forwarding policies set for other listeners.
The relationships between the protocol of the backend server group and the protocol used by the listener are as follows:
  • When the protocol used by the listener is TCP, the protocol of the backend server group must be TCP.
  • When the protocol used by the listener is UDP, the protocol of the backend server group must be UDP.
  • When the protocol used by the listener is HTTP or TERMINATED_HTTPS, the protocol of the backend server group must be HTTP.

admin_state_up

No

Boolean

Specifies the administrative status of the listener.

This parameter is reserved. The value can only be true.

default_tls_container_ref

No

String

Specifies the ID of the server certificate used by the listener.

The value contains a maximum of 128 characters.

This parameter is mandatory when protocol is set to TERMINATED_HTTPS.

client_ca_tls_container_ref

No

String

Specifies the ID of the CA certificate used by the listener.

The value contains a maximum of 128 characters.

sni_container_refs

No

Array

Lists the IDs of SNI certificates (server certificates with a domain name) used by the listener.

If the parameter value is an empty list, the SNI feature is disabled.

Response

Table 4 Response parameters

Parameter

Type

Description

listener

Object

Specifies the listener. For details, see Table 5.

Table 5 listener parameter description

Parameter

Type

Description

id

String

Specifies the listener ID.

tenant_id

String

Specifies the ID of the project where the listener is used.

The value contains a maximum of 255 characters.

name

String

Specifies the listener name.

The value contains a maximum of 255 characters.

description

String

Provides supplementary information about the listener.

The value contains a maximum of 255 characters.

protocol

String

Specifies the protocol used by the listener.

The value can be TCP, HTTP, UDP, or TERMINATED_HTTPS.

protocol_port

Integer

Specifies the port used by the listener.

The port number ranges from 1 to 65535.

loadbalancers

Array

Specifies the ID of the associated load balancer. For details, see Table 6.

connection_limit

Integer

Specifies the maximum number of connections.

The value ranges from -1 to 2147483647. The default value is -1, indicating that there is no restriction on the maximum number of connections.

This parameter is reserved.

admin_state_up

Boolean

Specifies the administrative status of the listener.

This parameter is reserved. Currently, the value can only be true.

http2_enable

Boolean

Specifies whether to use HTTP/2.

The value can be true or false.

  • true: HTTP/2 is used.
  • false: HTTP/2 is not used.

This parameter is valid only when the protocol used by the listener is set to TERMINATED_HTTPS.

default_pool_id

String

Specifies the ID of the associated backend server group.

If a request does not match the forwarding policy, the request is forwarded to the default backend server group for processing. If the value is null, the listener has no default backend server group.

default_tls_container_ref

String

Specifies the ID of the server certificate used by the listener. For details, see Certificate.

This parameter is mandatory when protocol is set to TERMINATED_HTTPS.

The value contains a maximum of 128 characters.

client_ca_tls_container_ref

String

Specifies the ID of the CA certificate used by the listener.

The value contains a maximum of 128 characters.

For details, see Certificate.

sni_container_refs

Array

Lists the IDs of SNI certificates (server certificates with a domain name) used by the listener.

If the parameter value is an empty list, the SNI feature is disabled.

tags

Array

Tags the listener.

created_at

String

Specifies the time when the listener was created. YYYY-MM-DDTHH:MM:SS

updated_at

String

Specifies the time when the listener was updated. YYYY-MM-DDTHH:MM:SS

Table 6 loadbalancers parameter description

Parameter

Mandatory

Type

Description

id

Yes

String

Specifies the ID of the associated load balancer.

Example Request

  • Example request: Updating a listener
    PUT https://{Endpoint}/v2/601240b9c5c94059b63d484c92cfe308/elb/listeners/f622c150-72f5-4263-a47a-e5003c652aa3
    { 
        "listener": { 
            "description": "my listener", 
            "name": "listener-jy-test2",
            "default_pool_id": "c61310de-9a06-4f0c-850c-6f4797b9984c",
            "default_tls_container_ref": "23b58a961a4d4c95be585e98046e657a",
            "client_ca_tls_container_ref": "417a0976969f497db8cbb083bff343ba"
        } 
    }

Example Response

  • Example response
    {
        "listener": {
            "client_ca_tls_container_ref": "417a0976969f497db8cbb083bff343ba",
            "protocol": "TERMINATED_HTTPS",
            "description": "my listener",
            "default_tls_container_ref": "23b58a961a4d4c95be585e98046e657a",
            "admin_state_up": true,
            "http2_enable": false,
            "loadbalancers": [
                {
                    "id": "165b6a38-5278-4569-b747-b2ee65ea84a4"
                }
            ],
            "tenant_id": "601240b9c5c94059b63d484c92cfe308",
            "sni_container_refs": [],
            "connection_limit": -1,
            "protocol_port": 443,
            "tags": [],
            "default_pool_id": "c61310de-9a06-4f0c-850c-6f4797b9984c",
            "id": "f622c150-72f5-4263-a47a-e5003c652aa3",
            "name": "listener-jy-test2",
            "created_at": "2018-07-25T01:54:13", 
     
            "updated_at": "2018-07-25T01:54:14"
     
        }
    }

Status Code

For details, see HTTP Status Codes of Load Balancers.