1. 接口描述
接口请求域名： waf.tencentcloudapi.com 。
获取防护配置中的精准白名单策略列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeCustomWhiteRule。 |
| Version | 是 | String | 公共参数，本接口取值：2018-01-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-guangzhou, ap-seoul 。 |
| Domain | 是 | String | 域名 示例值：test.qcloudwaf.com |
| Offset | 是 | Integer | 偏移量 示例值：1 |
| Limit | 是 | Integer | 容量 示例值：20 |
| Filters.N | 否 | Array of FiltersItemNew | 过滤数组,name可以是如下的值： RuleID,RuleName,Match |
| Order | 否 | String | asc或者desc 示例值：asc |
| By | 否 | String | exp_ts或者mod_ts 示例值：mod_ts |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RuleList | Array of DescribeCustomRulesRspRuleListItem | 规则详情 |
| TotalCount | String | 规则条数 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取精准白名单规则列表
输入示例
POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCustomWhiteRule
<公共请求参数>
{
"Domain": "test.qcloudwaf.com",
"Limit": 1,
"Filters": [
{
"Values": [
"1234567890"
],
"Name": "RuleID",
"ExactMatch": true
}
],
"Offset": 1
}输出示例
{
"Response": {
"RequestId": "5d207f4f-0d41-4f5d-bce2-0320090c98d8",
"RuleList": [
{
"EventId": "",
"ActionType": "1",
"Bypass": "geoip,cc,owasp,ai,antileakage",
"CreateTime": "2020-02-20 14:00:12",
"ExpireTime": "0",
"Name": "test",
"Redirect": "/",
"RuleId": "17958569",
"SortId": "100",
"Status": "1",
"Strategies": [
{
"Arg": "",
"CompareFunc": "ipmatch",
"Content": "1.1.1.2",
"Field": "IP"
}
]
}
],
"TotalCount": "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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InternalError.DBErr | DBErr |
| InvalidParameter | 参数错误。 |
| UnsupportedOperation | 操作不支持。 |