DescribeSecurityEventTimeSeriesMetric
查询攻击流量时序数据,攻击请求指的是命中规则并且被判定为有风险的请求
服务地址:
华东1(杭州)
输入参数
只看必填
InstanceId要操作的WAF实例ID
Filter查询过滤条件
DateRange查询时间范围
StartDate查询的数据范围不超过过去30天
EndDate查询数据时使用的结束时间
Conditions过滤条件列表
0单个查询条件配置
Key执行过滤操作的字段名称
OpValue操作符
Values过滤值
参数类型
string
Metric用于区分返回的数据内容
RegionIdWAF实例所属地域
ResourceManagerResourceGroupId阿里云资源组ID
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

攻击流量指的是命中规则并且被判定为有风险的请求。如下三种数据不包含:

  • 命中“白名单规则”的请求。
  • 命中 bot 规则,但是规则动作为“回源标记”的请求。
  • 命中规则并且规则动作为“动态令牌”/“滑块”/“严格滑块”/“js 验证”,但是用户校验通过并放行的请求。

请求参数

字段名称字段详情
InstanceIdstring

要操作的 WAF 实例 ID。展开详情

示例值:waf-cn-tl32ast****参考取值来源:
    SyncProductInstance
    DescribeInstance
    CreatePostpaidInstance
Filterobject

查询过滤条件,多个过滤条件之间是逻辑与的关系。

Metricstring

用于区分返回的数据内容,不同的 Metric 对应不同的数据内容,该接口支持的 Metric 如下:展开详情

示例值:mitigated_requests
RegionIdstring

WAF 实例所属地域。取值:展开详情

示例值:cn-hangzhou 参考取值来源:
    DescribeResourceRegionId
ResourceManagerResourceGroupIdstring

阿里云资源组 ID。

示例值:rg-acfm***q 参考取值来源:
    DescribeHybridCloudResources

请求说明

操作符说明

操作符含义说明
all-not-match不等于任一值字段值和数据集合中的任意数据都不相等,例如过滤 real_client_ip 不等于集合中任一值:
{"Key":"real_client_ip","OpValue":"all-not-match","Values":["1.1.1.1","2.2.2.2","3.3.3.3"]}
contain包含字段值包含某个字符串,例如过滤 URL 包含"test"的数据:
{"Key":"request_path","OpValue":"contain","Values":"test"}
eq等于字段值等于某个字符串,例如过滤 URL 等于"/testcase"的数据:
{"Key":"request_path","OpValue":"eq","Values":"/testcase"}
match-one等于多值之一字段值和数据集合中的任意一数据相等,例如过滤 real_client_ip 等于集合中任一值:
{"Key":"real_client_ip","OpValue":"match-one","Values":["1.1.1.1","2.2.2.2","3.3.3.3"]}
ne不等于字段值不等于某个字符串,例如过滤 URL 不等于"/testcase"的统计数据:
{"Key":"request_path","OpValue":"ne","Values":"/testcase"}
not-contain不包含字段值不包含某个字符串,例如过滤 URL 不包含"test"的数据:
{"Key":"request_path","OpValue":"not-contain","Values":"test"}
prefix-match前缀匹配字段值以某个字符串作为前缀,例如滤 URL 前缀是"/testcase"的数据:
{"Key":"request_path","OpValue":"prefix-match","Values":"/testcase"}
suffix-match后缀匹配字段值以某个字符串作为后缀,例如过滤 URL 后缀是"/testcase"的数据:
{"Key":"request_path","OpValue":"suffix-match","Values":"/testcase"}

过滤条件支持的 Key

字段名称字段含义支持的操作符
action防护动作,即该请求最终被处置的动作。ne、eq
cluster防护集群。ne、eq、
match-one、
all-not-match
defense_scene防护模块,一条请求可能命中多个防护模块,使用该字段过滤出的请求可能也会同时命中其它模块。ne、eq
hosthttp 头部的 host。contain、
not-contain、ne、eq、match-one、all-not-match、prefix-match、suffix-match
http_cookiehttp 头部的 cookie。contain、
not-contain、ne、eq、match-one、
all-not-match、prefix-match、suffix-match
http_user_agenthttp 头部获取的 User-Agent。contain、
not-contain、ne、eq、match-one、
all-not-match、prefix-match、suffix-match
matched_host防护对象。ne、eq、
match-one、
all-not-match
real_client_ip请求源 IP,操作符后跟随的参数只能是 IP 地址字符串或者 IP 地址字符串列表,不支持网段查询。ne、eq、
match-one、
all-not-match
remote_country_idhttp 请求源 IP 归属国家。ne、eq、
match-one、
all-not-match
remote_region_idhttp 请求源 IP 省市。ne、eq、
match-one、
all-not-match
request_methodhttp 请求方法。ne、eq、
match-one、
all-not-match
request_pathhttp 请求 URL,不包含 query。contain、
not-contain、ne、eq、match-one、
all-not-match、prefix-match、suffix-match
request_traceid标识请求的唯一 ID。ne、eq、
match-one、
all-not-match
rule_id规则 ID,一条请求可能命中多条规则,使用该字段过滤出的请求可能也会同时命中其它规则。ne、eq

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:D827FCFE-90A7-4330-9326-*****4C7726
SecurityEventTimeSeriesarray<object>

返回的时间序列数据,支持返回多个值的时间序列数据。

TimeSeriesMetaDataobject

返回数据的元信息。

返回说明

时间序列数据点时间粒度说明

查询数据时选择不同的时间范围,返回的数据的统计时间粒度不一样。

  • 查询时间范围小于 3 小时,返回的数据点的统计时间粒度为 1m(1 分钟)。
  • 查询时间范围大于等于 3 小时小于 6 小时,返回的数据点的统计时间粒度为 5m(5 分钟)。
  • 查询时间范围大于等于 6 小时小于 24 小时,返回的数据点的统计时间粒度为 15m(15 分钟)。
  • 查询时间范围大于等于 24 小时小于 7 天,返回的数据点的统计时间粒度为 1h(1 小时)。
  • 查询时间范围大于等于 7 天小于 30 天,返回的数据点的统计时间粒度为 1d(1 天)。
变更历史
变更时间变更内容概要操作
2025-03-27
新增OpenAPI,查询攻击流量时序数据