1. 接口描述
接口请求域名： waf.tencentcloudapi.com 。
获取域名的规则白名单
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeDomainWhiteRules。 |
| Version | 是 | String | 公共参数，本接口取值：2018-01-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-guangzhou, ap-seoul, ap-singapore 。 |
| Domain | 是 | String | 需要查询的域名 示例值：test.qcloudwaf.com |
| Url | 否 | String | 请求的白名单匹配路径 示例值：/test |
| Page | 否 | Integer | 翻到多少页 示例值：0 |
| Count | 否 | Integer | 每页展示的条数 示例值：10 |
| Sort | 否 | String | 排序方式,desc表示降序，asc表示升序 示例值：desc |
| RuleId | 否 | String | 规则ID 示例值：16 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RuleList | Array of RuleList | 规则列表 示例值：[{"CreateTime": "2024-05-27","Function": "eq","Id": 33371,"Rules": [22,72,73,85,86,87,88,90,91,92,],"Status": 1,"Time": "2023-11-07","Url": "/qw"}] |
| Total | Integer | 规则的数量 示例值：20 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取域名的规则白名单
获取域名的规则白名单
输入示例
POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDomainWhiteRules
<公共请求参数>
{
"Domain": "test.qcloudwaf.com"
}输出示例
{
"Response": {
"Total": 1,
"RequestId": "eac6b301-a322-493a-8e36-83b295459397",
"RuleList": [
{
"Id": 1,
"Rules": [
2,
3,
4
],
"Url": "/test",
"Function": "eq",
"Time": "2020-08-20 00:00:00",
"Status": 1
}
]
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.MysqlDBOperationFailed | 操作Mysql数据库失败 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
