全部產品
Search

搜尋本產品

    Web Application Firewall：DescribeNetworkFlowTimeSeriesMetric - 查詢網路流量時序資料

    文件中心

    Web Application Firewall：DescribeNetworkFlowTimeSeriesMetric - 查詢網路流量時序資料

    更新時間：Mar 17, 2026

    查詢所有流量的時序統計資料，包含惡意請求和正常的業務請求。

    調試

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

    調試

    授權資訊

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

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    yundun-waf:DescribeNetworkFlowTimeSeriesMetric

    get

    *全部資源

    *
    • acs:ResourceGroupId
    		 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    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>

    否

    過濾條件列表，每一個節點描述一個過濾條件。

    object

    否

    單個查詢條件配置，查詢條件由欄位名稱、操作符和過濾內容組成。關於查詢條件中支援的欄位名稱以及操作符請參見請求參數補充說明。

    Key

    string

    否

    執行過濾操作的欄位名稱，當前介面的 Key 只支援如下兩個欄位：

    • matched_host：防護對象。

    • cluster：防護叢集。

    matched_host

    OpValue

    string

    否

    操作符。

    eq

    Values

    any

    否

    過濾值。

    test.waf-top
    Metric

    string

    是

    用於區分返回的資料內容，不同的 Metric 對應不同的資料內容，該介面支援的 Metric 如下：

    • qps: 返回 waf 每秒處理的請求數，採用峰值計算方法，每 10 秒計算出一個 qps 值，最後從多個值中取最大峰值作為當前統計時間粒紋內的 qps 值。

    • total_requests: 返回 waf 處理的總請求數。

    • top5_status: 返回 waf 返回給用戶端的 top5 響應碼，以及對應的時間序列統計資料。

    • top 5_upstream_status: 返回來源站點返回給用戶端的 top5 響應碼，以及對應的時間序列統計資料。

    total_requests
    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.1.1.1","2.2.2.2","3.3.3.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.1.1.1","2.2.2.2","3.3.3.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-D33C8B4*****
    NetworkFlowTimeSeries

    array<object>

    返回的時間序列資料，支援返回多個值的時間序列資料。

    object

    單個時間序列資料，時間序列資料主要包含兩個數組，分別對應 Timestamps 和 Values 數組，Timestamps 數組中包含了固定時間間隔的時間序列，Values 數組中包含了每個固定時間間隔內的統計計數，這兩個數組包含的節點個數是一樣的，兩者的資料點是一一對應的關係。

    Metric

    string

    返回的資料內容，跟入參中的 Metric 含義保持一致。

    total_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。

    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-D33C8B4*****",
  "NetworkFlowTimeSeries": [
    {
      "Metric": "total_requests",
      "Timestamps": [
        "[]"
      ],
      "Values": [
        0
      ]
    }
  ],
  "TimeSeriesMetaData": {
    "DateRange": {
      "StartDate": 1713888000,
      "EndDate": 1713888600
    },
    "AggregateInterval": "1m",
    "Units": "requests"
  }
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

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

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

    變更歷史

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