1. API Description

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

This API is used to modify the attributes of a CLB instance listener, including the listener name, health check parameters, certificate information, and forwarding policy. This API does not support classic CLB instances.
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 Modifying the Certificate Bound to an HTTPS Listener

This example shows you how to modify the certificate bound to an HTTPS listener.

Input Example

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

{
    "ListenerId": "lbl-4fbxq45k",
    "Certificate": {
        "SSLMode": "UNIDIRECTIONAL",
        "CertId": "Nb1DY3hQ"
    },
    "LoadBalancerId": "lb-cuxw2rm0"
}

Output Example

{
    "Response": {
        "RequestId": "b64574f9-5bc7-4a63-a9d7-3671b6a6d62b"
    }
}

Example2 Modifying the Name, Health Check Parameters, and Forwarding Policy of a TCP Listener

This example shows you how to modify the name, health check parameters, and forwarding policy of a TCP listener.

Input Example

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

{
    "HealthCheck": {
        "UnHealthNum": 5,
        "HealthNum": 5,
        "IntervalTime": 60,
        "TimeOut": 35,
        "HealthSwitch": 1
    },
    "LoadBalancerId": "lb-cuxw2rm0",
    "ListenerId": "lbl-d1ubsydq",
    "ListenerName": "newlis",
    "Scheduler": "LEAST_CONN",
    "SessionExpireTime": 120
}

Output Example

{
    "Response": {
        "RequestId": "8cd88c83-fd30-47c0-8e7a-89bf13a7a83c"
    }
}

Example3 Modifying Listener Reschedule Parameters

Input Example

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

{
    "LoadBalancerId": "lb-fd9kpk4s",
    "ListenerId": "lbl-1sf4yxie",
    "RescheduleTargetZeroWeight": false,
    "RescheduleUnhealthy": false,
    "RescheduleExpandTarget": false,
    "RescheduleStartTime": 0,
    "RescheduleInterval": 0
}

Output Example

{
    "Response": {
        "RequestId": "e5854a85-faee-485e-8892-0a7cbca45080"
    }
}

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.