tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifySpartaProtectionMode

Last updated: 2024-11-27 09:46:31

1. API Description

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

Set WAF protection status

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: ModifySpartaProtectionMode.
Version Yes String Common Params. The value used for this API: 2018-01-25.
Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-guangzhou, ap-seoul.
Domain Yes String Domain name
Mode Yes Integer Protection status:
10: rule-based observation and AI disabling; 11: rule- and AI-based observation; 12: rule-based observation and AI-based interception
20: rule-based interception and AI disabling; 21: rule-based interception and AI-based observation; 22: rule- and AI-based interception
Edition No String Version of WAF. clb-waf indicates CLB WAF; sparta-waf indicates SaaS WAF. sparta-waf by default.
Type No Integer 0 is for modifying the Rule Engine Status; 1 is for modifying the AI Status

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 newEx

Input Example

POST / HTTP/1.1
Host: waf.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifySpartaProtectionMode
<common request parameters>

{
    "Edition": "字符串",
    "Domain": "why.qcloudwaf1234.com",
    "Type": "1",
    "Mode": "10"
}

Output Example

{
    "Response": {
        "RequestId": "7b393885-aaf2-463d-a70c-4500999d7c3f"
    }
}

Example2 Setting the Domain Name Protection Status

Input Example

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



{
    "Domain": "xx",
    "Mode": 21,
    "Edition": "sparta-waf"
}

Output Example

{
    "Response": {
        "RequestId": "225e3456-c296-475d-9338-b055667e6c85"
    }
}

Example3 Setting the Domain Name Protection Status (Failure)

Input Example

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



{
    "Domain": "xx",
    "Mode": 21,
    "Edition": "sparta-waf"
}

Output Example

{
    "Response": {
        "Error": {
            "Code": "InternalError",
            "Message": "Invalid mode."
        },
        "RequestId": "8bc47086-2922-4bfb-b154-db325abc1a28"
    }
}

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.
InternalError.DBErr DBErr
InvalidParameter Parameter error.
InvalidParameterValue Invalid parameter value.
LimitExceeded The quota limit is exceeded.
LimitExceeded.SpecificationErr SpecificationErr
MissingParameter Parameters are missing
ResourceInUse Resources are occupied.
ResourceInsufficient Insufficient resources.
ResourceNotFound Resources do not exist.
ResourceUnavailable Resources are unavailable.
ResourcesSoldOut Resources are sold out.
UnauthorizedOperation Unauthorized operation.
UnknownParameter Unknown parameter.
UnsupportedOperation The operation is not supported.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy