更新时间:2025-08-12 GMT+08:00

查询流量趋势

功能介绍

查询流量趋势,包括南北向、EIP、东西向的流量趋势

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/cfw/logs/traffic-trend

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以从调API处获取,也可以从控制台获取。项目ID获取方式

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

fw_instance_id

String

参数解释

防火墙ID,用户创建防火墙实例后产生的唯一ID,配置后可区分不同防火墙,可通过防火墙ID获取方式获取

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

range

Integer

参数解释

时间范围

约束限制

不涉及

取值范围

0为近一时 1近一天 2近七天

默认取值

不涉及

log_type

String

参数解释

日志类型

约束限制

不涉及

取值范围

internet为南北向日志、nat为nat场景日志,vpc为东西向日志,vgw为vgw场景日志

默认取值

不涉及

start_time

Long

参数解释

开始时间

约束限制

不涉及

取值范围

毫秒级时间戳

默认取值

不涉及

end_time

Long

参数解释

结束时间

约束限制

不涉及

取值范围

毫秒级时间戳

默认取值

不涉及

vgw_id

Array of strings

参数解释

VGW ID

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

agg_type

String

参数解释

聚合类型

约束限制

不涉及

取值范围

avg为平均值 max为最大值

默认取值

不涉及

ip

Array of strings

参数解释

IP地址列表,查看IP的流量趋势

约束限制

不涉及

取值范围

IP地址

默认取值

不涉及

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

data

Array of TrafficTrendVO objects

参数解释

流量趋势数据

取值范围

不涉及

表4 TrafficTrendVO

参数

参数类型

描述

agg_time

Long

参数解释

聚合时间点

取值范围

不涉及

bps

Double

参数解释

bps

取值范围

不涉及

in_bps

Double

参数解释

入方向bps

取值范围

不涉及

out_bps

Double

参数解释

出方向bps

取值范围

不涉及

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码

取值范围

不涉及

error_msg

String

参数解释

错误描述

取值范围

不涉及

请求示例

查询项目ID为a16df7cf1d094befa6bbc72cbf51e93a防火墙ID为c598d612-8112-465c-bffd-863d4ce85a50时间范围为7天的vpc间流量趋势,计算方式为最大值

https://{Endpoint}/v1/a16df7cf1d094befa6bbc72cbf51e93a/cfw/logs/traffic-trend?fw_instance_id=c598d612-8112-465c-bffd-863d4ce85a50&range=2&log_type=vpc&agg_type=max

响应示例

状态码:200

OK

{
  "data" : [ {
    "agg_time" : 1750299480000,
    "bps" : 0
  } ]
}

状态码:400

Bad Request

{
  "error_code" : "CFW.00200007",
  "error_msg" : "时间范围错误"
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码