tencent cloud

文档反馈

DeleteRules

最后更新时间:2024-10-11 15:52:03

    1. API Description

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

    This API is used to batch delete rules from the rule engine.

    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: DeleteRules.
    Version Yes String Common Params. The value used for this API: 2022-09-01.
    Region No String Common Params. This parameter is not required.
    ZoneId Yes String ID of the site
    RuleIds.N Yes Array of String IDs of the rules to be deleted.

    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 Batch deleting rules from the rule engine

    Input Example

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DeleteIdlFiles
    <Common request parameters>
    
    {
        "RuleIds": [
            "rule-66tjz30m",
            "rule-bx3zke8q"
        ],
        "ZoneId": "zone-26r78x31ny86"
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "ace05891-744c-40f8-94de-4e1c08d954c2"
        }
    }
    

    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.ConfigLocked The configuration is locked. Please unlock and try again.
    InternalError.ProxyServer An unknown error occurred in the backend server.
    InternalError.SystemError Internal system error.
    InvalidParameter.ActionInProgress Too many attempts. Please try again later.
    InvalidParameter.ErrInvalidActionParam Invalid operation: Invalid parameter.
    InvalidParameter.ErrInvalidActionParamValue Invalid action.
    InvalidParameter.InvalidHttps Invalid parameter "https".
    InvalidParameter.InvalidHttpsCipherSuiteAndTlsVersion The cipher suite does not match the TLS version.
    InvalidParameter.InvalidRangeOriginPull Invalid Range GETs.
    InvalidParameter.InvalidRuleEngineNotFound The rule does not exist.
    InvalidParameter.NotSupportThisPreset Unsupported preset variables exist.
    InvalidParameter.ZoneNotFound The site does not exist.
    OperationDenied Operation denied.
    OperationDenied.DisableZoneNotCompleted The EdgeOne service of the site is being disabled. Please try again later.
    OperationDenied.ErrZoneIsAlreadyPaused The EdgeOne service of the site is disabled. Please enable it and try again.
    ResourceInUse The resource is occupied.
    UnauthorizedOperation.CamUnauthorized CAM is not authorized.