DescribeOwaspWhiteRules

Last updated:2025-10-30 22:08:28

DescribeOwaspWhiteRules

Last updated: 2025-10-30 22:08:28

1. API Description

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

This API is used to retrieve the allowlist for 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: DescribeOwaspWhiteRules.
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 to be queried
Offset	No	Integer	Paginate, defaults to 0.
Limit	No	Integer	Capacity per page. defaults to 10.
By	No	String	Specifies the field used to sort. valid values: CreateTime (creation time), UpdateTime (update time).
Order	No	String	Sorting method. supports asc, desc.
Filters.N	No	Array of FiltersItemNew	Filter conditions, support RuleId: whitelist rule ID, Name: rule Name, RuleType: whitelist rule type, Status: rule enabling Status, ValidStatus: rule effective Status, TimerType: effective method, ID: specific whitelist ID, determine whether it is a rule ID or type ID based on RuleType.

3. Output Parameters

Parameter Name	Type	Description
Total	Integer	Total number of rules.
List	Array of OwaspWhiteRule	Rule allowlist list
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 Show Allowlist

Input Example

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

{
    "Domain": "owasp.saas3.testwaf.com"
}

Output Example

{
    "Response": {
        "List": [],
        "RequestId": "f04cbb2c-7276-49b3-8576-c6c9ff9eb7bb",
        "Total": 0
    }
}

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

Tencent Cloud CLI 3.0

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
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.
InternalError.DBErr	DBErr
InvalidParameter	Parameter error.
InvalidParameter.InvalidCertificate	Invalid certificate content.
InvalidParameter.QueryCertBySSLIDFailed	Failed to query certificate by ID.
InvalidParameterValue	Invalid parameter value.
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.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud