Web 应用防火墙获取api安全配置规则列表

1. 接口描述

接口请求域名： waf.tencentcloudapi.com 。

获取api安全敏感规则列表

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeApiSecSensitiveRuleList。
Version	是	String	公共参数，本接口取值：2018-01-25。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-guangzhou, ap-seoul, ap-singapore 。
Domain	是	String	域名示例值：qcloudwaf.com
IsQueryApiExtractRule	否	Boolean	是否查询api提取规则策略，true表示查询示例值：false
IsQueryApiPrivilegeRule	否	Boolean	是否查询api鉴权规则示例值：false
IsQueryApiSceneRule	否	Boolean	是否查询api场景规则示例值：false
RuleName	否	String	查询鉴权配置的时候，该rule只返回鉴权配置的规则示例值："ddpd"
IsQueryApiCustomEventRule	否	Boolean	是否查询api自定义事件规则示例值：false
IsQueryApiExcludeRule	否	Boolean	是否查询无效api排除策略示例值：false

3. 输出参数

参数名称	类型	描述
Data	Array of ApiSecSensitiveRule	api敏感规则列表注意：此字段可能返回 null，表示取不到有效值。
Total	Integer	规则数量注意：此字段可能返回 null，表示取不到有效值。示例值：10
Status	Integer	自定义敏感检测规则总开关示例值：0
RuleNameList	Array of String	非内置规则的rulename列表注意：此字段可能返回 null，表示取不到有效值。示例值：["asd"]
ApiExtractRule	Array of ApiSecExtractRule	api提取规则列表注意：此字段可能返回 null，表示取不到有效值。
ApiSecPrivilegeRule	Array of ApiSecPrivilegeRule	api鉴权规则列表注意：此字段可能返回 null，表示取不到有效值。
ApiSecSceneRule	Array of ApiSecSceneRule	api场景规则列表注意：此字段可能返回 null，表示取不到有效值。
ApiSecCustomEventRule	Array of ApiSecCustomEventRule	自定义事件规则注意：此字段可能返回 null，表示取不到有效值。
ApiExcludeRule	Array of ApiSecExcludeRule	无效api排除规则列表注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取指定类型的API安全相关规则

获取指定类型的API安全相关规则

输入示例

POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApiSecSensitiveRuleList
<公共请求参数>

{
    "Domain": "xxx.testwaf.com",
    "IsQueryApiExtractRule": true
}

输出示例

{
    "Response": {
        "ApiExcludeRule": null,
        "ApiExtractRule": null,
        "ApiSecCustomEventRule": null,
        "ApiSecPrivilegeRule": null,
        "ApiSecSceneRule": null,
        "Data": null,
        "RuleNameList": null,
        "Status": 1,
        "Total": 0,
        "RequestId": "56b9948c-9b1d-4839-9e21-857a266db0d9"
    }
}

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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
UnsupportedOperation	操作不支持。

获取api安全配置规则列表

本页目录：