Last updated: 2021-04-07 19:47:23

1. API Description

Domain name for API request:

This API is used to create a listener for a CLB instance.
This is an async API. After it is returned successfully, you can call the DescribeTaskStatus API with the returned RequestId as an input parameter to check whether this task is successful.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example:

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: CreateListener.
Version Yes String Common parameter. The value used for this API: 2018-03-17.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
LoadBalancerId Yes String CLB instance ID
Ports.N Yes Array of Integer Specifies for which ports to create listeners. Each port corresponds to a new listener.
Protocol Yes String Listener protocol: TCP, UDP, HTTP, HTTPS, or TCP_SSL (which is currently in beta test. If you want to use it, please submit a ticket for application).
ListenerNames.N No Array of String List of names of the listeners to be created. The array of names and array of ports are in one-to-one correspondence. If you do not want to name them now, you do not need to provide this parameter.
HealthCheck No HealthCheck Health check parameter, which is applicable only to TCP, UDP, and TCP_SSL listeners.
Certificate No CertificateInput Certificate information. This parameter is applicable only to TCP_SSL listeners and HTTPS listeners with the SNI feature not enabled.
SessionExpireTime No Integer Session persistence time in seconds. Value range: 30-3,600. The default value is 0, indicating that session persistence is not enabled. This parameter is applicable only to TCP/UDP listeners.
Scheduler No String Forwarding method of a listener. Value range: WRR, LEAST_CONN.
They represent weighted round robin and least connections, respectively. Default value: WRR. This parameter is applicable only to TCP/UDP/TCP_SSL listeners.
SniSwitch No Integer Whether to enable the SNI feature. This parameter is applicable only to HTTPS listeners
TargetType No String Target real server type. NODE: binding a general node; TARGETGROUP: binding a target group.
SessionType No String Session persistence type. Valid values: Normal: the default session persistence type; QUIC_CID: session persistence by QUIC connection ID. The QUIC_CID value can only be configured in UDP listeners. If this field is not specified, the default session persistence type will be used.
KeepaliveEnable No Integer Whether to enable a persistent connection. This parameter is applicable only to HTTP and HTTPS listeners. Valid values: 0 (disable; default value) and 1 (enable).
EndPort No Integer This parameter is used to specify the end port and is required when creating a port range listener. Only one member can be passed in when inputting the Ports parameter, which is used to specify the start port. If you want to try the port range feature, please submit a ticket.

3. Output Parameters

Parameter Name Type Description
ListenerIds Array of String Array of unique IDs of the created listeners
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating two TCP listeners lis0 and lis1 to listen on ports 7569 and 7570 respectively

This example shows you how to create two TCP listeners lis0 and lis1 to listen on ports 7569 and 7570 respectively.

Input Example
&<Common request parameters>

Output Example

  "Response": {
    "ListenerIds": [
    "RequestId": "8f272cef-14ff-458c-b67e-1bd21bd2942b"

Example2 Setting health check information while creating a TCP listener

Input Example