DeleteRule

Last updated: 2025-11-25 10:11:23

DeleteRule

Last updated: 2025-11-25 10:11:23

1. API Description

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

This API is used to delete forwarding rules under a layer-7 listener of a load balancing instance.
This API is used to perform asynchronous operations. After it returns 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: DeleteRule.
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	ID of the CLB instance listener. You can call the DescribeListeners API to query the ID.
LocationIds.N	No	Array of String	Array of ids of forwarding rules to be deleted, can be accessed through the DescribeLoadBalancersDetail api.
Domain	No	String	Domain name of the forwarding rule to be deleted. if it is multiple domains, you can specify any one of the domain name list. it can be accessed through the DescribeLoadBalancersDetail api.
Url	No	String	Forwarding path of the forwarding rule to be deleted can be accessed through the DescribeLoadBalancersDetail api (https://www.tencentcloud.comom/document/api/214/46916?from_cn_redirect=1).
NewDefaultServerDomain	No	String	A default domain name must be configured under the listener. when you need to delete the default domain name, you can specify another domain name as the new default domain name. if the new default domain name is multiple domains, you can specify any one of the domain name list. it 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 forwarding rule

Input Example

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

{
    "Url": "/bar2",
    "Domain": "foo.net",
    "ListenerId": "lbl-4fbxq45k",
    "LoadBalancerId": "lb-cuxw2rm0"
}

Output Example

{
    "Response": {
        "RequestId": "ba2d4eb1-c7c5-480c-98e4-9b7b6a0fd498"
    }
}

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

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.

Error Code	Description
FailedOperation	Operation failed.
FailedOperation.ResourceInOperating	The specified resource is currently being operated. Please try again later.
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

Feedback

tencent cloud