調用DescribeNetworkFlowTopNMetric按多維度彙總統計網路流量TopN-Web Application Firewall-阿里雲

查詢所有流量按照不同維度彙總統計並進行排序後的top統計資料，包含惡意請求和正常的業務請求。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-waf:DescribeNetworkFlowTopNMetric

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	WAF 執行個體 ID。說明您可以通過調用 DescribeInstance 介面查看當前 WAF 執行個體 ID。	waf_cdnsdf3****
Filter	object	是	查詢過濾條件，多個過濾條件之間是邏輯與的關係。
DateRange	object	是	查詢時間範圍。
StartDate	integer	是	查詢的資料範圍不超過過去 30 天。查詢資料時使用的開始時間，使用 UNIX 時間戳記表示，單位：秒。說明開始時間必須晚於目前時間減去 30 天。	1713888000
EndDate	integer	是	查詢資料時使用的結束時間，使用 UNIX 時間戳記表示，單位：秒。	1713888600
Conditions	array	否	過濾條件列表，每一個節點描述一個過濾條件。
	object	否	單個查詢條件配置，查詢條件由欄位名稱、操作符和過濾內容組成。關於查詢條件中支援的欄位名稱以及操作符請參見請求參數補充說明。
Key	string	否	執行過濾操作的欄位名稱，當前介面的 Key 只支援如下兩個欄位： matched_host cluster	matched_host
OpValue	string	否	操作符。	eq
Values	any	否	過濾值。	test.waf-top
Limit	integer	是	控制統計資料按照降序排序後返回資料條數，最大值為 10。	10
Metric	string	是	用於區分返回的資料內容，不同的 Metric 對應不同的資料內容，該介面支援的 Metric 如下： real_client_ip，目前使用者所有經過 waf 的請求，按照請求源 IP 彙總統計並降序排序後，返回前 N 條資料。 http_user_agent，目前使用者所有經過 waf 的請求，按照請求的 user-agent 彙總統計並降序排序後，返回前 N 條資料。 request_path，目前使用者所有經過 waf 的請求，按照請求的 URL 彙總統計並降序排序後，返回前 N 條資料。 matched_host_by_total_requests，返回目前使用者請求數最大的 N 個防護對象以及對應的請求數。 matched_host_by_qps，返回目前使用者 QPS 最大的 N 個防護對象以及對應的 QPS 資料 matched_host_by_status，使用該 Metric 時需要在 Filter 的 Conditions 欄位指定 status，waf 返回的 HTTP 響應碼等於 Conditions 中指定的 status 的資料按照防護對象彙總統計並排序後，返回前 N 條資料。指定 status 的格式如下： {"Key":"status","OpValue":"eq","Values":"200"} matched_host_by_upstream_status，使用該 Metric 時需要在 Filter 的 Conditions 欄位指定 upstream_status，來源站點返回的 HTTP 響應碼等於 Conditions 中指定的 upstream_status 的資料按照防護對象彙總統計並排序後，返回前 N 條資料。指定 upstream_status 的格式如下： {"Key":"upstream_status","OpValue":"eq","Values":"200"}	matched_host_by_upstream_status
RegionId	string	否	WAF 執行個體所屬地區。取值： cn-hangzhou：表示中國內地。 ap-southeast-1：表示非中國內地。	cn-hangzhou
ResourceManagerResourceGroupId	string	否	阿里雲資源群組 ID。	rg-acfm***q

操作符說明

操作符	含義	說明
all-not-match	不等於任一值	欄位值和資料集合中的任意資料都不相等，例如過濾 real_client_ip 不等於集合中任一值： `{"Key":"real_client_ip","OpValue":"all-not-match","Values":["1.XX.XX.1","2.XX.XX.2","3.XX.XX.3"]}`
eq	等於	欄位值等於某個字串，例如設定過濾條件為 URL 等於"/testcase"的統計資料： `{"Key":"request_path","OpValue":"eq","Values":"/testcase"}`
match-one	等於多值之一	欄位值和資料集合中的任意一資料相等，例如過濾 real_client_ip 等於集合中任一值： `{"Key":"real_client_ip","OpValue":"match-one","Values":["1.XX.XX.1","2.XX.XX.2","3.XX.XX.3"]}`
ne	不等於	欄位值不等於某個字串，例如設定過濾條件為 URL 不等於"/testcase"的統計資料： `{"Key":"request_path","OpValue":"ne","Values":"/testcase"}`

過濾條件支援的 Key

欄位名稱	欄位含義	支援的操作符
cluster	防護叢集。	ne、eq、 match-one、 all-not-match
matched_host	防護對象。	ne、eq、 match-one、 all-not-match

返回參數

名稱	類型	描述	樣本值
	object	返回的資料結果，格式範例參見樣本。
RequestId	string	請求 ID。	D827FCFE-90A7-4330-9326-******4C7726
NetworkFlowTopNValues	array<object>	返回的 top 統計資料數組。
	object	每一個點對應一條 top 統計資料。
Name	string	某個欄位的值，根據查詢的 Metric 不同，代表不同的含義。	127.0.0.1
Attribute	string	用於返回額外的資訊，比如返回某個 IP 所屬的國家和省市資訊。	CN
Value	integer	用於 top 排序的統計計數。	1123
TopNMetaData	object	返回資料的元資訊。
DateRange	object	查詢時使用的時間範圍。
StartDate	integer	查詢資料時使用的開始時間，使用 UNIX 時間戳記表示，單位：秒。該值和入參數重的 StartDate 一致。	1713888000
EndDate	integer	查詢資料時使用的結束時間，使用 UNIX 時間戳記表示，單位：秒。該值和入參數重的 EndDate 一致。	1713888600
Units	string	返回的統計資料的單位。	requests

樣本

正常返回樣本

JSON格式

{
  "RequestId": "D827FCFE-90A7-4330-9326-******4C7726",
  "NetworkFlowTopNValues": [
    {
      "Name": "127.0.0.1",
      "Attribute": " CN",
      "Value": 1123
    }
  ],
  "TopNMetaData": {
    "DateRange": {
      "StartDate": 1713888000,
      "EndDate": 1713888600
    },
    "Units": "requests\n"
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	Waf.Report.%s	Invalid parameter:%s.	無效的參數：%s
400	Waf.Report.InternalError	Server error occurred in report service.	報表格服務內部錯誤

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。