tencent cloud

DeleteListener
Last updated:2026-01-13 21:46:42
DeleteListener
Last updated: 2026-01-13 21:46:42

1. API Description

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

This API is used to delete listeners (layer-4 and layer-7) under a Cloud Load Balancer instance.
This API is used to perform asynchronous operations. After returning a successful result, 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.

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: DeleteListener.
Version Yes String Common Params. The value used for this API: 2018-03-17.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
LoadBalancerId Yes String ID of the CLB instance. You can call the DescribeLoadBalancers API to query the ID.
ListenerId Yes String The listener ID to be deleted, can be accessed through the DescribeListeners api.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Deleting a listener

Input Example

https://clb.intl.tencentcloudapi.com/?Action=DeleteListener
&LoadBalancerId=lb-cuxw2rm0
&ListenerId=lbl-4udz130k
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "eeb315e4-7333-4f0e-814f-2f44ffd13e4c"
    }
}

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.
InternalError Internal error.
InvalidParameter Parameter error.
InvalidParameter.FormatError Wrong parameter format.
InvalidParameterValue Incorrect parameter value.
InvalidParameterValue.Length Wrong parameter length.
UnauthorizedOperation Unauthorized operation.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback