Last updated: 2020-03-16 17:04:18

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:

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/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

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. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.


TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

5. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Parameter error.
InvalidParameter.FormatError Wrong parameter format.
InvalidParameterValue Wrong parameter value.
InvalidParameterValue.Length Wrong parameter length.
LimitExceeded Reached quota.
MissingParameter Missing parameter.
ResourceInsufficient Insufficient resource.
UnauthorizedOperation Unauthorized operation.