1. API Description

Domain name for API request: clb.intl.tencentcloudapi.com.

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

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

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.

3. Output Parameters

4. Example

Example1 Creating an HTTPS Listener and Binding an Existing Certificate

This example shows you how to create an HTTPS listener and bind an existing certificate.

Input Example

POST / HTTP/1.1
Host: clb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateListener
<Common request parameters>

{
    "Protocol": "HTTPS",
    "Ports": [
        7572
    ],
    "Certificate": {
        "SSLMode": "UNIDIRECTIONAL",
        "CertId": "MsJyaXVm"
    },
    "LoadBalancerId": "lb-cuxw2rm0"
}

Output Example

{
    "Response": {
        "ListenerIds": [
            "lbl-4fbxq45k"
        ],
        "RequestId": "db8ae69f-ebda-402b-8d02-ead459aa6ff9"
    }
}

Example2 Creating a TCP Listener and Configuring the Health Check Settings

This example shows you how to create a TCP listener and configure the health check settings.

Input Example

POST / HTTP/1.1
Host: clb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateListener
<Common request parameters>

{
    "HealthCheck": {
        "UnHealthNum": 4,
        "HealthNum": 4,
        "IntervalTime": 7,
        "TimeOut": 5,
        "HealthSwitch": 1
    },
    "Protocol": "TCP",
    "Ports": [
        7571
    ],
    "LoadBalancerId": "lb-cuxw2rm0"
}

Output Example

{
    "Response": {
        "ListenerIds": [
            "lbl-lbbxvq26"
        ],
        "RequestId": "fff13c83-dcb5-481a-ba7c-30e92c276c19"
    }
}

Example3 Creating an HTTPS Listener and Binding a New Certificate

This example shows you how to create an HTTPS listener and bind a new certificate.

Input Example

POST / HTTP/1.1
Host: clb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateListener
<Common request parameters>

{
    "Protocol": "HTTPS",
    "Ports": [
        7573
    ],
    "Certificate": {
        "SSLMode": "UNIDIRECTIONAL",
        "CertContent": "-----BEGINCERTIFICATE-----\\nxxxxxxxxxxxxxxxxxxxxxxx\\n-----ENDCERTIFICATE-----",
        "CertName": "my-cert",
        "CertKey": "-----BEGINRSAPRIVATEKEY-----\\nxxxxxxxxxxxxxxxxxxxxxxxx\\n-----ENDRSAPRIVATEKEY-----"
    },
    "LoadBalancerId": "lb-cuxw2rm0"
}

Output Example

{
    "Response": {
        "ListenerIds": [
            "lbl-bzfmg9m6"
        ],
        "RequestId": "6082314c-030c-429d-9eae-2dc6b159b5b9"
    }
}

Example4 Creating a UDP Listener with the Default Ping Health Check

This example shows you how to create a UDP listener with the default Ping health check.

Input Example

POST / HTTP/1.1
Host: clb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateListener
<Common request parameters>

{
    "HealthCheck": {
        "HealthSwitch": 1
    },
    "Protocol": "UDP",
    "ListenerNames": [
        "lis_test"
    ],
    "Ports": [
        432
    ],
    "LoadBalancerId": "lb-6wlxe9rj"
}

Output Example

{
    "Response": {
        "ListenerIds": [
            "lbl-aev333n1"
        ],
        "RequestId": "3b81f03e-6088-448d-abaf-8a487d4f985a"
    }
}

Example5 Creating Two TCP Listeners (Respectively Named lis0 and lis1) to Respectively Listen on Ports 7569 and 7570

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

Input Example

POST / HTTP/1.1
Host: clb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateListener
<Common request parameters>

{
    "ListenerNames": [
        "lis1",
        "lis0"
    ],
    "Protocol": "TCP",
    "Ports": [
        7570,
        7569
    ],
    "LoadBalancerId": "lb-cuxw2rm0"
}

Output Example

{
    "Response": {
        "ListenerIds": [
            "lbl-d1ubsydq",
            "lbl-4udz130k"
        ],
        "RequestId": "8f272cef-14ff-458c-b67e-1bd21bd2942b"
    }
}

Example6 Creating a Listener and Enabling Rescheduling

Input Example

POST / HTTP/1.1
Host: clb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateListener
<Common request parameters>

{
    "LoadBalancerId": "lb-fd9kpk4s",
    "Ports": [
        5689
    ],
    "Protocol": "tcp",
    "RescheduleTargetZeroWeight": true,
    "RescheduleUnhealthy": true,
    "RescheduleExpandTarget": true,
    "RescheduleStartTime": 25,
    "RescheduleInterval": 50
}

Output Example

{
    "Response": {
        "ListenerIds": [
            "lbl-1sf4yxie"
        ],
        "RequestId": "6aa274e5-ff78-4e9e-b13c-30a9e21b107e"
    }
}

5. Developer Resources

SDK

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

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for Node.js
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

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