查詢攻擊流量時序資料,攻擊請求指的是命中規則並且被判定為有風險的請求。
介面說明
攻擊流量指的是命中規則並且被判定為有風險的請求。如下三種資料不包含:
命中“白名單規則”的請求。
命中 bot 規則,但是規則動作為“回源標記”的請求。
命中規則並且規則動作為“動態令牌”/“滑塊”/“嚴格滑塊”/“js 驗證”,但是使用者校正通過並允許存取的請求。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
yundun-waf:DescribeSecurityEventTimeSeriesMetric |
get |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| InstanceId |
string |
是 |
要操作的 WAF 執行個體 ID。 說明
您可以調用 DescribeInstance 查詢 WAF 執行個體的 ID。 |
waf-cn-tl32ast**** |
| Filter |
object |
是 |
查詢過濾條件,多個過濾條件之間是邏輯與的關係。 |
|
| DateRange |
object |
是 |
查詢時間範圍。 |
|
| StartDate |
integer |
是 |
查詢的資料範圍不超過過去 30 天。查詢資料時使用的開始時間,使用 UNIX 時間戳記表示,單位:秒。 說明
開始時間必須晚於目前時間減去 30 天。 |
1713888000 |
| EndDate |
integer |
是 |
查詢資料時使用的結束時間,使用 UNIX 時間戳記表示,單位:秒。 |
1713888600 |
| Conditions |
array |
否 |
過濾條件列表,每一個節點描述一個過濾條件。 |
|
|
object |
否 |
單個查詢條件配置,查詢條件由欄位名稱、操作符和過濾內容組成。關於查詢條件中支援的欄位名稱以及操作符請參見請求參數補充說明。 |
||
| Key |
string |
否 |
執行過濾操作的欄位名稱,該介面支援所有欄位。 |
matched_host |
| OpValue |
string |
否 |
操作符。 |
eq |
| Values |
any |
否 |
過濾值。 |
test.waf-top |
| Metric |
string |
是 |
用於區分返回的資料內容,不同的 Metric 對應不同的資料內容,該介面支援的 Metric 如下:
|
mitigated_requests |
| RegionId |
string |
否 |
WAF 執行個體所屬地區。取值:
|
cn-hangzhou |
| ResourceManagerResourceGroupId |
string |
否 |
阿里雲資源群組 ID。 |
rg-acfm***q |
操作符說明
| 操作符 | 含義 | 說明 |
| 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 |
| host | http 頭部的 host。 | contain、 not-contain、ne、eq、match-one、all-not-match、prefix-match、suffix-match |
| http_cookie | http 頭部的 cookie。 | contain、 not-contain、ne、eq、match-one、 all-not-match、prefix-match、suffix-match |
| http_user_agent | http 頭部擷取的 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_id | http 請求源 IP 歸屬國家。 | ne、eq、 match-one、 all-not-match |
| remote_region_id | http 請求源 IP 省市。 | ne、eq、 match-one、 all-not-match |
| request_method | http 要求方法。 | ne、eq、 match-one、 all-not-match |
| request_path | http 請求 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 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回的資料結果,格式範例參見樣本。 |
||
| RequestId |
string |
請求 ID。 |
D827FCFE-90A7-4330-9326-*****4C7726 |
| SecurityEventTimeSeries |
array<object> |
返回的時間序列資料,支援返回多個值的時間序列資料。 |
|
|
object |
單個時間序列資料,時間序列資料主要包含兩個數組,分別對應 Timestamps 和 Values 數組,Timestamps 數組中包含了固定時間間隔的時間序列,Values 數組中包含了每個固定時間間隔內的統計計數,這兩個數組包含的節點個數是一樣的,兩者的資料點是一一對應的關係。 |
||
| Metric |
string |
返回的資料內容,跟入參中的 Metric 含義保持一致。 |
monitored_requests |
| Timestamps |
array |
時間序列,每個點代表一個時間範圍的起始時間。 |
|
|
string |
每個資料統計點的起始統計時間,使用 UNIX 時間戳記字串表示。 |
[] |
|
| Values |
array |
資料序列,每個點代表一定時間範圍內的統計計數。 |
|
|
integer |
目前時間範圍的統計計數。 |
[] |
|
| TimeSeriesMetaData |
object |
返回資料的元資訊。 |
|
| DateRange |
object |
查詢時使用的時間範圍。 |
|
| StartDate |
integer |
查詢資料時使用的開始時間,使用 UNIX 時間戳記表示,單位:秒。該值和入參數重的 StartDate 一致。 |
1713888000 |
| EndDate |
integer |
查詢資料時使用的結束時間,使用 UNIX 時間戳記表示,單位:秒。該值和入參數重的 EndDate 一致。 |
1713888600 |
| AggregateInterval |
string |
返回的時間序列資料中,每個資料點的統計時間粒紋,比如"15m"則表示返回的每個資料點是每 15 分鐘的統計資料。返回資料的時間粒紋參見時間數列資料點時間粒紋說明。 |
1m |
| Units |
string |
返回的統計資料的單位。 |
requests |
時間數列資料點時間粒紋說明
查詢資料時選擇不同的時間範圍,返回的資料的統計時間粒紋不一樣。
查詢時間範圍小於 3 小時,返回的資料點的統計時間粒紋為 1m(1 分鐘)。
查詢時間範圍大於等於 3 小時小於 6 小時,返回的資料點的統計時間粒紋為 5m(5 分鐘)。
查詢時間範圍大於等於 6 小時小於 24 小時,返回的資料點的統計時間粒紋為 15m(15 分鐘)。
查詢時間範圍大於等於 24 小時小於 7 天,返回的資料點的統計時間粒紋為 1h(1 小時)。
查詢時間範圍大於等於 7 天小於 30 天,返回的資料點的統計時間粒紋為 1d(1 天)。
樣本
正常返回樣本
JSON格式
{
"RequestId": "D827FCFE-90A7-4330-9326-*****4C7726\n",
"SecurityEventTimeSeries": [
{
"Metric": "monitored_requests",
"Timestamps": [
"[]"
],
"Values": [
0
]
}
],
"TimeSeriesMetaData": {
"DateRange": {
"StartDate": 1713888000,
"EndDate": 1713888600
},
"AggregateInterval": "1m",
"Units": "requests\n"
}
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | Waf.Report.%s | Invalid parameter:%s. | 無效的參數:%s |
| 400 | Waf.Report.InternalError | Server error occurred in report service. | 報表格服務內部錯誤 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。