tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

UpsertCCRule

Last updated: 2024-09-25 10:13:08

1. API Description

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

WAF CC V2 upsert API

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: UpsertCCRule.
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, ap-singapore.
Domain Yes String Domain name
Name Yes String Name
Status Yes Integer Status
Advance Yes String Advanced mode (whether to use session detection). 0: disabled; 1: enabled
Limit Yes String CC detection threshold
Interval Yes String CC detection cycle
Url Yes String Detection URL
MatchFunc Yes Integer Matching method. 0: equal to; 1: prefix matching; 2: included
ActionType Yes String Action. 20: observation; 21: CAPTCHA; 22: interception; 23: precise interception
Priority Yes Integer Priority
ValidTime Yes Integer Valid time for action
OptionsArr No String Additional Parameters
Edition No String WAF version. The value can be sparta-waf or clb-waf.
Type No Integer Operation type
EventId No String Source event ID for adding rules
SessionApplied.N No Array of Integer Session ID that needs to be enabled for the rule
RuleId No Integer Rule ID: fill in 0 when adding
CreateTime No Integer Rule creation time
Length No Integer URL length

3. Output Parameters

Parameter Name Type Description
Data String Normally null

Note: This field may return null, indicating that no valid values can be obtained.
RuleId Integer Operated RuleId
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 test

Input Example

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



{
    "Status": "0",
    "MatchFunc": "0",
    "Domain": "hzh.qcloud.com",
    "Name": "ddp",
    "Advance": "0",
    "ValidTime": "61",
    "Interval": "10",
    "Priority": "1",
    "Url": "/test",
    "Limit": "10",
    "ActionType": "20"
}

Output Example

{
    "Response": {
        "RequestId": "2ca5c6bb-05b7-4183-bbf2-3c7059544317",
        "Data": ""
    }
}

Example2 test1

Input Example

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



{
    "Status": "0",
    "MatchFunc": "0",
    "Domain": "hzh.qcloud.com",
    "Name": "ddp",
    "Advance": "0",
    "ValidTime": "61",
    "Interval": "10",
    "Priority": "1",
    "Url": "/test",
    "Limit": "10",
    "ActionType": "20"
}

Output Example

{
    "Response": {
        "RequestId": "2ca5c6bb-05b7-4183-bbf2-3c7059544317",
        "Data": ""
    }
}

Example3 WAF CC V2 upsert API

Input Example

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



{
    "Status": "0",
    "Advance": "0",
    "Domain": "test.com",
    "Name": "test2",
    "Url": "/test",
    "Priority": "50",
    "Interval": "60",
    "MatchFunc": "0",
    "ValidTime": "600\n",
    "Limit": "60",
    "ActionType": "22",
    "OptionsArr": "[{\"key\":\"get\",\"args\":[\"a=12\"]}]"
}

Output Example

{
    "Response": {
        "Data": null,
        "RequestId": "5029e2b0-493c-4dcc-9e4e-d53ab98ede99"
    }
}

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.
LimitExceeded.SpecificationErr SpecificationErr
UnsupportedOperation The operation is not supported.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy