DescribeNetworkFlowTopNMetric - 查询网络流量top统计数据_Web应用防火墙(WAF)-阿里云帮助中心

查询所有流量按照不同维度聚合统计并进行排序后的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	long	是	查询的数据范围不超过过去 30 天。查询数据时使用的开始时间，使用 UNIX 时间戳表示，单位：秒。说明开始时间必须晚于当前时间减去 30 天。	1713888000
EndDate	long	是	查询数据时使用的结束时间，使用 UNIX 时间戳表示，单位：秒。	1713888600
Conditions	array<object>	否	过滤条件列表，每一个节点描述一个过滤条件。
	object	否	单个查询条件配置，查询条件由字段名称、操作符和过滤内容组成。关于查询条件中支持的字段名称以及操作符请参见请求参数补充说明。
Key	string	否	执行过滤操作的字段名称，当前接口的 Key 只支持如下两个字段： matched_host cluster	matched_host
OpValue	string	否	操作符。	eq
Values	any	否	过滤值。	test.waf-top
Limit	long	是	控制统计数据按照降序排序后返回数据条数，最大值为 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 统计数据数组。
TopNValue	object	每一个点对应一条 top 统计数据。
Name	string	某个字段的值，根据查询的 Metric 不同，代表不同的含义。	127.0.0.1
Attribute	string	用于返回额外的信息，比如返回某个 IP 所属的国家和省市信息。	CN
Value	long	用于 top 排序的统计计数。	1123
TopNMetaData	object	返回数据的元信息。
DateRange	object	查询时使用的时间范围。
StartDate	long	查询数据时使用的开始时间，使用 UNIX 时间戳表示，单位：秒。该值和入参数重的 StartDate 一致。	1713888000
EndDate	long	查询数据时使用的结束时间，使用 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.	报表服务内部错误

访问错误中心查看更多错误码。