1. 接口描述
接口请求域名: waf.tencentcloudapi.com 。
获取用户规则白名单列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeAttackWhiteRule。 |
Version | 是 | String | 公共参数,本接口取值:2018-01-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou, ap-seoul 。 |
Domain | 是 | String | 需要查询的域名 示例值:test.qcloudwaf.com |
Offset | 是 | Integer | 分页 示例值:1 |
Limit | 是 | Integer | 每页容量 示例值:1 |
By | 否 | String | 排序的字段,支持user_id, signature_id, modify_time 示例值:signature_id |
Order | 否 | String | 排序方式 示例值:asc |
Filters.N | 否 | Array of FiltersItemNew | 筛选条件,支持SignatureId, MatchContent 示例值: [{"Name": "Status", Values: ["1"], "ExactMatch": true}] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Total | Integer | 规则总数 示例值:1 |
List | Array of UserWhiteRule | 规则白名单列表 示例值:[{"WhiteRuleId": 16071,"Name": "testWhite","SignatureId": "10000266","SignatureIds": ["10000266"],"TypeId": "010000000","TypeIds": ["010000000"],"Mode": 0,"Status": 1,"MatchField": "URL","MatchMethod": "eq","MatchContent": "/testuu","MatchInfo": [{"MatchField": "URL","MatchParams": "","MatchMethod": "eq","MatchContent": "/testuu"}],"MatchInfoStr": "[{"MatchField":"URL","MatchParams":"","MatchMethod":"eq","MatchContent":"/testuu"}]","CreateTime": "2024-11-04T19:30:02+08:00","ModifyTime": "2024-11-04T19:30:02+08:00"}] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询示例
输入示例
POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAttackWhiteRule
<公共请求参数>
{
"Domain": "test.domain.com",
"Offset": 0,
"Limit": 10,
"Order": "dsc",
"By": "modify_time"
}
输出示例
{
"Response": {
"Total": 1,
"List": [
{
"WhiteRuleId": 14931,
"Name": "whiteRuleName",
"SignatureId": "30000163",
"SignatureIds": [
"30000163"
],
"TypeId": "01000000",
"TypeIds": [
"10000001"
],
"Mode": 0,
"Status": 1,
"MatchField": "URL",
"MatchMethod": "eq",
"MatchContent": "/asdfad",
"MatchInfo": [
{
"MatchField": "URL",
"MatchMethod": "eq",
"MatchContent": "/asdfad"
}
],
"MatchInfoStr": "[{\"MatchField\":\"URL\",\"MatchParams\":\"\",\"MatchMethod\":\"eq\",\"MatchContent\":\"/asdfad\"}]",
"CreateTime": "2024-10-29T21:19:12+08:00",
"ModifyTime": "2024-10-29T21:19:12+08:00"
}
],
"RequestId": "d3f9fc57-dbfd-4503-ad95-eab902c6257c"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InternalError.DBErr | DBErr |
InvalidParameter | 参数错误。 |
InvalidParameter.InvalidCertificate | 证书内容非法。 |
InvalidParameter.QueryCertBySSLIDFailed | 根据ID查询证书失败。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |