Adding a Listener

Function

This API is used to add a listener to a load balancer.

Constraints

Only users with the ELB administrator permissions can specify the value of connection_limit.
The value of protocol can be TCP, HTTP, UDP, or TERMINATED_HTTPS.

URI

POST /v2/{project_id}/elb/listeners

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.

Request

**Table 2** Parameter description
Parameter	Mandatory	Type	Description
listener	Yes	Listener object	Specifies the listener. For details, see Table 3.

**Table 3** **listener** parameter description
Parameter	Mandatory	Type	Description
tenant_id	No	String	Specifies the ID of the project where the listener is used. The value must be the same as the value of project_id in the token. The value contains a maximum of 255 characters.
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.
protocol	Yes	String	Specifies the protocol used by the listener. The value can be TCP, HTTP, UDP, or TERMINATED_HTTPS.
protocol_port	Yes	Integer	Specifies the port used by the listener. The port number ranges from 1 to 65535. NOTE: If the protocol used by the listener is UDP, the port number cannot be 4789.
loadbalancer_id	Yes	String	Specifies the ID of the associated load balancer.
connection_limit	No	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	No	Boolean	Specifies the administrative status of the listener. This parameter is reserved, and the default value is true.
http2_enable	No	Boolean	Specifies whether to use HTTP/2. The value can be true or false. true: HTTP/2 will be used. false: HTTP/2 will not be used. The default value is false. This parameter takes effect 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.
default_tls_container_ref	No	String	Specifies the ID of the server certificate used by the listener. This parameter is mandatory when protocol is set to TERMINATED_HTTPS. The default value is null when protocol is not set to TERMINATED_HTTPS. The value contains a maximum of 128 characters. NOTE: This parameter takes effect only when the protocol used by the listener is set to TERMINATED_HTTPS.
client_ca_tls_container_ref	No	String	Specifies the ID of the CA certificate used by the listener. The default value is null. The value contains a maximum of 128 characters. NOTE: This parameter takes effect only when the protocol used by the listener is set to TERMINATED_HTTPS.
sni_container_refs	No	Array	Lists the IDs of SNI certificates (server certificates with domain names) used by the listener. If the parameter value is an empty list, the SNI feature is disabled. The default value is []. NOTE: This parameter takes effect only when the protocol used by the listener is set to TERMINATED_HTTPS.

Response

**Table 4** Response parameters
Parameter	Type	Description
listener	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 of Loadbalancers objects	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. The value can be true or false. true: Enabled false: Disabled
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 takes effect 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 domain names) 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 1: Adding a TCP listener

POST https://{Endpoint}/v2/145483a5107745e9b3d80f956713e6a3/elb/listeners

{
    "listener": {
        "protocol_port": 80,
        "protocol": "TCP",
        "loadbalancer_id": "0416b6f1-877f-4a51-987e-978b3f084253",
        "name": "listener-test",
       
        "admin_state_up": true
    }
}

Example request 2: Adding a listener with protocol set to TERMINATED_HTTPS

POST https://{Endpoint}/v2/601240b9c5c94059b63d484c92cfe308/elb/listeners

{ 
    "listener": { 
        "protocol_port": 25, 
        "protocol": "TERMINATED_HTTPS", 
        "default_tls_container_ref": "02dcd56799e045bf8b131533cc911dd6",
        "loadbalancer_id": "0416b6f1-877f-4a51-987e-978b3f084253", 
        "name": "listener-test",
        "admin_state_up": true
    } 
}

Example Response

Example response 1

{
    "listener": {
        "protocol_port": 80,
        "protocol": "TCP",
        "description": "",
        "client_ca_tls_container_ref": null,
        "default_tls_container_ref": null,
        "admin_state_up": true,
        "http2_enable": false,
        "loadbalancers": [
            {
                "id": "0416b6f1-877f-4a51-987e-978b3f084253"
            }
        ],
        "tenant_id": "145483a5107745e9b3d80f956713e6a3",
 
        "sni_container_refs": [],
        "connection_limit": -1,
        "default_pool_id": null,
        "tags": [],
        "id": "b7f32b52-6f17-4b16-9ec8-063d71b653ce",
        "name": "listener-test",
        "created_at": "2018-07-25T01:54:13", 
        "updated_at": "2018-07-25T01:54:14"
     }
}

Example response 2

{
    "listener": {
        "insert_headers": {},
        "protocol_port": 25,
        "protocol": "TERMINATED_HTTPS",
        "description": "",
        "default_tls_container_ref": "02dcd56799e045bf8b131533cc911dd6",
        "sni_container_refs": [],
        "loadbalancers": [
            {
                "id": "0416b6f1-877f-4a51-987e-978b3f084253"
            }
        ],
        "tenant_id": "601240b9c5c94059b63d484c92cfe308",
   
        "created_at": "2019-01-21T12:38:31",
        "client_ca_tls_container_ref": null,
        "connection_limit": -1,
        "updated_at": "2019-01-21T12:38:31",
        "http2_enable": false,
        "admin_state_up": true,
        "default_pool_id": null,
        "id": "b56634cd-5ba8-460e-b5a2-6de5ba8eaf60",
        "tags": [],
        "name": "listener-test"
    }
}

Example response 3

{
    "listener": {
        "insert_headers": {},
        "protocol_port": 27,
        "protocol": "TERMINATED_HTTPS",
        "description": "",
        "default_tls_container_ref": "02dcd56799e045bf8b131533cc911dd6",
        "sni_container_refs": [
            "5882325fd6dd4b95a88d33238d293a0f",
            "e15d1b5000474adca383c3cd9ddc06d4"
        ],
        "loadbalancers": [
            {
                "id": "6bb85e33-4953-457a-85a9-336d76125b7b"
            }
        ],
        "tenant_id": "601240b9c5c94059b63d484c92cfe308",
 
        "created_at": "2019-01-21T12:43:55", 
        "client_ca_tls_container_ref": null,
        "connection_limit": -1,
        "updated_at": "2019-01-21T12:43:55",
        "http2_enable": false,
        "admin_state_up": true,
        "default_pool_id": null,
        "id": "b2cfda5b-52fe-4320-8845-34e8d4dac2c7",
        "tags": [],
        "name": "listener-test"
    }
}