文档首页/云防火墙 CFW/API参考 (联盟区域) /API/日志管理/查询流日志
更新时间：2025-12-29 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询流日志

功能介绍

查询流日志

URI

GET /v1/{project_id}/cfw/logs/flow

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式

表2 Query参数

参数

是否必选

参数类型

描述

fw_instance_id

是

String

防火墙id，可通过防火墙ID获取方式获取

direction

否

String

方向，包含in2out，out2in

log_type

否

String

日志类型包括：internet，vpc，nat

start_time

是

Long

开始时间，以毫秒为单位的时间戳，如1718936272648

end_time

是

Long

结束时间，以毫秒为单位的时间戳，如1718936272648

src_ip

否

String

源IP

src_port

否

Integer

源端口

dst_ip

否

String

目的IP

dst_port

否

Integer

目的端口

protocol

否

String

协议类型，包含TCP, UDP,ICMP,ICMPV6等。

app

否

String

规则应用类型包括：“HTTP”，"HTTPS"，"TLS1"，“DNS”，“SSH”，“MYSQL”，“SMTP”，“RDP”，“RDPS”，“VNC”，“POP3”，“IMAP4”，“SMTPS”，“POP3S”，“FTPS”，“ANY”,“BGP”等。

log_id

否

String

文档ID,第一页为空，其他页不为空，其他页可取上一次查询最后一条数据的log_id

next_date

否

Long

下个日期，当是第一页时为空，不是第一页时不为空，其他页可取上一次查询最后一条数据的start_time

offset

否

Integer

偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于0，首页时为空，非首页时不为空

limit

是

Integer

每页显示个数，范围为1-1024

enterprise_project_id

否

String

企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0

dst_host

否

String

目的主机

src_region_name

否

String

源region名称

dst_region_name

否

String

目的region名称

src_province_name

否

String

源省份名称

dst_province_name

否

String

目的省份名称

src_city_name

否

String

源城市名称

dst_city_name

否

String

目的城市名称

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。可通过如何获取用户Token获取。

Content-Type

是

String

内容类型，只有application/json的值是适用的

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

data

data object

查询流日志返回值数据

表5 data

参数

参数类型

描述

total

Integer

查询流日志返回值记录总数

limit

Integer

每页显示个数，范围为1-1024

records

Array of records objects

记录

表6 records

参数

参数类型

描述

bytes

Double

字节

direction

String

方向，有内到外（in2out）和外到内（out2in）两种

packets

Integer

字节包数

start_time

Long

开始时间，以毫秒为单位的时间戳，如1718936272648

end_time

Long

结束时间，以毫秒为单位的时间戳，如1718936272648

log_id

String

文档ID

src_ip

String

源IP

src_port

Integer

源端口

dst_ip

String

目的IP

app

String

规则应用类型包括：“HTTP”，"HTTPS"，"TLS1"，“DNS”，“SSH”，“MYSQL”，“SMTP”，“RDP”，“RDPS”，“VNC”，“POP3”，“IMAP4”，“SMTPS”，“POP3S”，“FTPS”，“ANY”,“BGP”等。

dst_port

Integer

目的端口

protocol

String

协议类型:TCP为6,UDP为17,ICMP为1,ICMPV6为58,ANY为-1,手动类型不为空，自动类型为空

dst_host

String

目标主机

dst_region_id

String

目的地域id

dst_region_name

String

目的地域名称

src_region_id

String

源地域id

src_region_name

String

源地域名称

dst_province_id

String

目的省份id

dst_province_name

String

目的省份名称

dst_city_id

String

目的城市id

dst_city_name

String

目的城市名称

src_province_id

String

源省份id

src_province_name

String

源省份名称

src_city_id

String

源城市id

src_city_name

String

源城市名称

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

查询项目id为9d80d070b6d44942af73c9c3d38e0429防火墙id为2af58b7c-893c-4453-a984-bdd9b1bd6318，起点时间为1663555012000，终点时间为1664159798000的首页的流日志。

https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/cfw/logs/flow?fw_instance_id=2af58b7c-893c-4453-a984-bdd9b1bd6318&start_time=1663555012000&end_time=1664159798000&limit=10

响应示例

状态码：200

查询流日志返回值

{
  "data" : {
    "limit" : 10,
    "records" : [ {
      "app" : "SSH",
      "bytes" : 34.5,
      "direction" : "out2in",
      "dst_ip" : "100.95.148.49",
      "dst_port" : 22,
      "end_time" : 1664155493000,
      "log_id" : "76354",
      "packets" : 25,
      "protocol" : "TCP",
      "src_ip" : "100.93.27.17",
      "src_port" : 49634,
      "start_time" : 1664155428000,
      "src_province_id" : "source province id",
      "src_province_name" : "source province name",
      "src_city_id" : "source city id",
      "src_city_name" : "source city name",
      "dst_province_id" : "dst province id",
      "dst_province_name" : "dst province name",
      "dst_city_id" : "dst city id",
      "dst_city_name" : "dst city name"
    } ],
    "total" : 1
  }
}

状态码：400

Bad Request

{
  "error_code" : "CFW.00500002",
  "error_msg" : "时间间距错误"
}

状态码

状态码

描述

200

查询流日志返回值

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题：日志管理