tencent cloud

Feedback

CreateListener

Last updated: 2022-06-01 18:41:49

1. API Description

Domain name for API request: ecm.tencentcloudapi.com.

This API is used to create a CLB listener.

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

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 Params. The value used for this API: CreateListener.
Version Yes String Common Params. The value used for this API: 2019-07-19.
Region No String Common Params. This parameter is not required for this API.
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. Valid values: TCP, UDP
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 parameters
SessionExpireTime No Integer Session persistence time in seconds. Value range: 30–3600. 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 the listener. Valid values: WRR, LEAST_CONN.
They represent weighted round robin and least connections, respectively. Default value: WRR.
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.
EndPorts.N No Array of Integer End ports of port ranges, which must be the same as Ports in length.

3. Output Parameters

Parameter Name Type Description
ListenerIds Array of String Array of unique IDs of the created listeners
Note: this field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating CLB listener

Input Example

https://ecm.tencentcloudapi.com/?Action=CreateListener
&LoadBalancerId=lb-f9zyj3kb
&Ports.0=13001
&Ports.1=13002
&Ports.2=13003
&Protocol=TCP
&<Common request parameters>

Output Example

{
  "Response": {
    "ListenerIds": [
      "lbl-knd4jr8m",
      "lbl-2fcyclbg",
      "lbl-m5f7z60y"
    ],
    "RequestId": "28b4ba78-0100-4ebe-8afd-a09cf09a6ffe"
  }
}

5. Developer Resources

SDK

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

Command Line Interface

6. 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.
FailedOperation.InternalOperationFailure Internal error.
InvalidParameter.FormatError The parameter format is incorrect.
InvalidParameter.InvalidDataFormat The data format is incorrect.
InvalidParameterValue.InvalidPublicParam The common parameter is invalid.
InvalidParameterValue.Length The parameter length is incorrect.
LimitExceeded The quota limit is exceeded.
UnauthorizedOperation.ForbiddenOperation You don't have the permission to perform this operation.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support