tencent cloud

文档反馈

ModifyModuleStatus

最后更新时间:2024-09-25 10:12:26

1. API Description

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

Set the switch for the basic security module under a certain domain

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: ModifyModuleStatus.
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 to be set
WebSecurity Yes Integer Enabling status of the web security module. The value is 0 or 1.
AccessControl Yes Integer Access control module switch: 0 or 1
CcProtection Yes Integer CC module switch, 0 or 1
ApiProtection Yes Integer API security module switch, 0 or 1
AntiTamper No Integer Tamper-proof module switch: 0 or 1
AntiLeakage No Integer Leakage prevention module switch: 0 or 1
RateLimit No Integer Traffic limiting module switch: 0 or 1

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 Modifying the Module Status

Input Example

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



{
    "Domain": "zjm.qcloudwaf.com",
    "WebSecurity": 1,
    "AccessControl": 1,
    "CcProtection": 1,
    "AntiTamper": 1,
    "AntiLeakage": 1,
    "ApiProtection": 1
}

Output Example

{
    "Response": {
        "RequestId": "abc-edf"
    }
}

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
InternalError Internal error.