Docs

Load Balancer

Listener

DeleteListener - Deleting a listener

Call the DeleteListener API to delete the listener.

Instructions

The CLB instance does not have modification protection enabled.

You can call the DescribeLoadBalancers API to check if modification protection is enabled. If enabled, call the ModifyLoadBalancerAttributes API to disable it.

For a layer-7 listener, the listener does not have custom forwarding rules associated.

You can call the DescribeRules API to check whether custom forwarding rules are associated. If associated, you can call the DeleteRules API to delete custom forwarding rules.

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Action String required Example: DeleteListener

Action to execute. Set the value to DeleteListener.

Version String required Example: 2020-04-01

API version. The current version is 2020-04-01.

ListenerId String required Example: lsn-2fek3rgsxhrsw5oxruwec****

Listener ID.

You can call the DescribeListeners API to query the listener ID.

Response parameters

RequestId String Example: 20210811152539010225146063030****

Request ID.

Request examples

GET /?Action=DeleteListener&Version=2020-04-01&ListenerId=lsn-2fek3rgsxhrsw5oxruwec****​
Host: clb.cn-beijing.volcengineapi.com​
X-Date: 20251121T094038Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251121/cn-beijing/clb/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​

Response examples

{​
    "ResponseMetadata": {​
        "RequestId": "20230604110420****100232280022D31",​
        "Action": "DeleteListener",​
        "Version": "2020-04-01",​
        "Service": "clb",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "RequestId": "20210811152539010225146063030****"​
    }​
}​

Error codes

This section displays only the error codes of the current API. For more error codes, see Common error codes.

Status code	Error codes	Error message	Notes
400	InvalidListenerRule.InUse	The specified Listener has dependent resources Rule is in use.	The specified listener has forwarding rules in use.
400	InvalidLoadBalancer.InvalidStatus	The specified LoadBalancer is not in the correct status for the request.	The specified load balancer cannot respond to this request due to its status.
400	MissingParameter	The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, the 'ListenerId'.	This request is missing a required parameter. Please ensure the request includes all required parameters, such as ListenerId.
400	MissingParameter	The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, the ''.	This request is missing a required parameter. Ensure the request includes all required parameters, such as .
403	Forbidden	You are not authorized to perform operations on the specified service.	You do not have permission to perform operations on the specified service.
403	InvalidResourceType.ServcieManaged	The specified ResourceType is managed by a service.	The specified resource is a service-managed resource.
404	InvalidListener.NotFound	The specified Listener does not exist.	The specified listener does not exist.
404	InvalidLoadBalancer.NotFound	The specified LoadBalancer does not exist.	The specified load balancer does not exist.
500	InternalError	An internal error has occurred.	An internal error occurred.

Last updated: 2026.05.09 10:33:41