文档中心

Web应用防火墙

漏洞防护

GetVulnerabilityConfig - 获取漏洞配置

获取指定域名的漏洞防护等级/防护动作/高级防护配置/SQL 语义检测配置和规则集统计信息。

注意事项

服务接口调用总上限：1000 QPS

单账号调用上限：50 QPS

请求说明

请求方式：POST

请求地址：https://waf.volcengineapi.com/?Action=GetVulnerabilityConfig&Version=2023-12-25

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

Action String 必选示例值：GetVulnerabilityConfig

接口名称。当前 API 的名称为 GetVulnerabilityConfig。

Version String 必选示例值：2023-12-25

接口版本。当前 API 的版本为 2023-12-25。

Body

ProjectName String 可选示例值：default

资源所属项目名称。获取方式可参考ListProjectResources - 获取项目资源列表。

Host String 可选示例值：example.volcwaf001.com

当HostAddType为1或未传递HostAddType时，用于指定单个域名。

HostAddType Integer 可选示例值：1

域名的指定方式，默认值为 1。支持的取值如下所示：

1：单域名，此时使用 Host 字段指定单个域名；

3：域名列表，此时使用 HostList字段指定多域名列表。

HostList String[] 可选示例值：["a.b.com"]

当HostAddType为3时使用，用于指定多个已接入当前WAF实例的域名，且域名不能重复。

返回参数

Action String 示例值：observe

执行动作。

block：对于命中漏洞防护规则的请求进行拦截。

observe：对于命中漏洞防护规则的请求放行，并记录日志。

AdvanceConfig Object 示例值：-

漏洞防护的高级配置，包含目录遍历防护和高频扫描防护。

AutoTraversal Object 示例值：-

目录遍历防护的配置对象，启用后按统计对象和触发次数识别目录遍历行为。

Enable Boolean 示例值：true

目录遍历防护的开关，当多域名查询且配置不一致时返回 null。

true：开启

false：关闭

Rule Object 示例值：-

目录遍历防护的规则配置详情。

Action Integer 示例值：2

处置动作，支持的取值如下所示。

0：观察；

2：拦截。

CountTime Integer 示例值：60

统计时长，单位为秒，取值范围 1～60。

EffectTime Integer 示例值：600

处置生效时长，单位秒，取值范围 10~2592000.

EffectTimeViewUnit String 示例值：min

处置时长单位：

s：秒

min：分钟

hour：小时

day：天

Field String 示例值：CLIENTIP

统计对象，目录遍历防护当前支持 CLIENTIP，表示源 IP。

HitRequestCount Integer 示例值：20

请求触发次数，取值范围 1~100。

ResponseHttpStatus Integer[] 示例值：[400]

自定义响应状态码列表。

ResponseHttpStatusHitPercent Integer 示例值：80

响应状态码命中百分比，取值范围 0~99。

RuleTag String 示例值： N000000000001

规则标签。

FreqScan Object 示例值：-

高频扫描防护配置，启用后按统计对象、请求触发次数和规则触发次数识别高频扫描行为。

Enable Boolean 示例值：true

高频扫描防护的开关，当多域名查询且配置不一致时返回 null。支持的取值如下所示。

true：开启高频扫描防护；

false：关闭高频扫描防护。

Rule Object 示例值：--

高频扫描防护的规则配置详情，启用高频扫描防护时建议传入该配置，若不传则仅更新高频扫描防护的启用状态。

Action Integer 示例值：2

高频扫描防护规则的处置动作。支持的取值如下所示。

0：观察；

2：拦截。

CountTime Integer 示例值：60

统计时长，单位秒，取值范围 1~60。

EffectTime Integer 示例值：600

处置生效时长，单位秒，取值范围 10~2592000。

EffectTimeViewUnit String 示例值：min

前端展示的处置时长单位。支持的取值如下所示。

s：秒；

min：分钟；

hour：小时；

day：天。

Field String 示例值：CLIENTIP

统计对象，支持 CLIENTIP 或 HEADER:{Header-Name}，例如 HEADER:User-Agent。

HitRequestCount Integer 示例值：20

请求触发次数，取值范围 1~100.

RuleTag String 示例值：P000000000001

规则标签。

RuleMode String 示例值：normal

漏洞防护等级。支持的取值如下所示。

strict：严格；

normal：正常；

loose：宽松；

custom：自定义。

当多域名查询且配置不一致时返回 null。

RuleSetInfo Object 示例值：-

系统漏洞规则集的统计信息。

错误码

您可访问公共错误码，获取更多错误码信息。

输入示例 1

输入示例

POST https://waf.volcengineapi.com/?Action=GetVulnerabilityConfig&Version=2023-12-25&ProjectName=default
X-Date: 20230711T035055Z
Authorization: HMAC-SHA256 Credential=AKLTNGU0OGEyMT***/20230711/cn-beijing/waf/request, SignedHeaders=content-type;x-content-sha256;x-date, Signature=da4fac562d00f41ad8***

{
  "Host": "example.volcwaf001.com",
  "HostAddType": 1,
  "HostList": [
    "a.b.com"
  ]
}

输出示例

{
    "ResponseMetadata": {
        "RequestId": "20231009200242CE25C146B591DDCE****",
        "Action": "GetVulnerabilityConfig",
        "Version": "2023-12-25",
        "Service": "waf",
        "Region": "cn-beijing"
    },
    "Result": {
        "Action": "observe",
        "AdvanceConfig": {
            "AutoTraversal": {
                "Enable": true,
                "Rule": {
                    "Action": 1,
                    "CountTime": 1,
                    "EffectTime": 1,
                    "EffectTimeViewUnit": "2023-10-09T20:02:42Z",
                    "Field": "123456",
                    "HitRequestCount": 1,
                    "ResponseHttpStatus": [
                        1
                    ],
                    "ResponseHttpStatusHitPercent": 1
                },
                "RuleTag": "D000000003624"
            },
            "FreqScan": {
                "Enable": true,
                "Rule": {
                    "Action": 1,
                    "CountTime": 1,
                    "EffectTime": 1,
                    "EffectTimeViewUnit": "2023-10-09T20:02:42Z",
                    "Field": "123456",
                    "HitRequestCount": 1,
                    "HitRuleCount": 1
                },
                "RuleTag": "D000000003624"
            }
        },
        "RuleMode": "normal",
        "RuleSetInfo": {},
        "SemanticSQL": {
            "Action": "observe",
            "Enable": 1,
            "RuleTag": "D000000003624"
        }
    }
}

最近更新时间：2026.06.03 17:05:17

这个页面对您有帮助吗？

有用

无用