tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DeleteRule

最后更新时间：2023-10-24 11:16:13

    1. API Description

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

    This API (DeleteRule) is used to delete a forwarding rule under a layer-7 CLB instance listener
    This is an async API. After it is returned successfully, you can 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 No String Common Params. This parameter is not required for this API.
    LoadBalancerId Yes String CLB instance ID
    ListenerId Yes String CLB listener ID
    LocationIds.N No Array of String Array of IDs of the forwarding rules to be deleted
    Domain No String The domain name associated with the forwarding rule to delete. If the rule is associated with multiple domain names, specify any one of them.
    Url No String The forwarding path of the forwarding rule to delete.
    NewDefaultServerDomain No String Specifies a new default domain name for the listener. This field is used when the original default domain name is disabled. If there are multiple domain names, specify one of them.

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Deleting a forwarding rule

    Input Example

    POST / HTTP/1.1
Host: clb.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

    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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款