Release Notes
Product Announcement
Security Advisory
Domain name for API request: waf.intl.tencentcloudapi.com.
This API is used to add a rule engine allowlist.
A maximum of 20 requests can be initiated per second for this API.
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: CreateOwaspWhiteRule. |
| 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. |
| Name | Yes | String | Rule name |
| Domain | Yes | String | Domain name |
| Strategies.N | Yes | Array of Strategy | Rule-Based matching policy list. |
| Ids.N | Yes | Array of Integer | ID list of allowlisted rules. |
| Type | Yes | Integer | Allowlist type. valid values: 0 (allowlisting by specific rule ID), 1 (allowlisting by rule type). |
| JobType | Yes | String | Rule execution mode: TimedJob indicates scheduled execution. CronJob indicates periodic execution. |
| JobDateTime | Yes | JobDateTime | Scheduled task configuration |
| ExpireTime | Yes | Integer | If the JobDateTime field is not set, this field is used. 0 means permanent, other values indicate the cutoff time for scheduled effect (unit: seconds). |
| Status | No | Integer | Rule status. valid values: 0 (disabled), 1 (enabled). enabled by default. |
| Parameter Name | Type | Description |
|---|---|---|
| RuleId | Integer | Rule ID |
| 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. |
POST / HTTP/1.1
Host: waf.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateOwaspWhiteRule
<Common request parameters>
{
"Name": "Test allowlist",
"Domain": "owasp.saas3.testwaf.com",
"Strategies": [
{
"Field": "IP",
"CompareFunc": "eq",
"Content": "1.1.1.1",
"Arg": "GET"
}
],
"Ids": [
16
],
"Type": 1,
"JobType": "TimedJob",
"JobDateTime": {
"Timed": [
{
"StartDateTime": 0,
"EndDateTime": 0
}
],
"TimeTZone": "UTC+8\t"
},
"ExpireTime": 0,
"Status": 1
}{
"Response": {
"RuleId": "23123145",
"RequestId": "01006b52-0313-4771-83eb-968d7b592dfa"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| DryRunOperation | DryRun operation means the request will be successful, but the DryRun parameter is passed. |
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| InvalidParameter.InvalidCertificate | Invalid certificate content. |
| InvalidParameter.QueryCertBySSLIDFailed | Failed to query certificate by ID. |
| InvalidParameterValue | Invalid parameter value. |
| InvalidParameterValue.InvalidRequest | InvalidRequest |
| LimitExceeded | The quota limit is exceeded. |
| MissingParameter | Parameters are missing |
| OperationDenied | Operation denied. |
| RequestLimitExceeded | Too frequent requests |
| 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. |
文档反馈