文档首页/ 云防火墙 CFW/ API参考/ API/ 日志分析/ 查询流量日志统计
更新时间:2025-08-28 GMT+08:00
分享

查询流量日志统计

功能介绍

查询流量日志统计

调用方法

请参见如何调用API

URI

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

表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场景日志

默认取值

不涉及

direction

String

参数解释

会话方向

约束限制

不涉及

取值范围

in2out为出云方向 out2in为入云方向

默认取值

不涉及

start_time

Long

参数解释

开始时间

约束限制

不涉及

取值范围

毫秒级时间戳

默认取值

不涉及

end_time

Long

参数解释

结束时间

约束限制

不涉及

取值范围

毫秒级时间戳

默认取值

不涉及

vgw_id

Array of strings

参数解释

VGW ID

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

asset_type

String

参数解释

IP类型

约束限制

不涉及

取值范围

public 公网IP

private 私网IP

open_port

默认取值

不涉及

item

String

参数解释

聚合类型

约束限制

不涉及

取值范围

src_ip 源IP

dst_ip 目的IP

dst_port 目的端口

protocol 协议

dst_host 目的域名

app 应用

dst_region_name 目的地区

src_region_name 源地区

risk_ip 风险IP

risk_host 风险域名

open_port 开放端口

默认取值

不涉及

size

Integer

参数解释

聚合条数

约束限制

不涉及

取值范围

0到10条

默认取值

5

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

data

data object

参数解释

流量日志统计

取值范围

不涉及

表4 data

参数

参数类型

描述

records

Array of FlowDetailsVO objects

参数解释

统计记录

取值范围

不涉及

total

Long

参数解释

总数

取值范围

不涉及

表5 FlowDetailsVO

参数

参数类型

描述

apps

Array of ItemVO objects

参数解释

应用统计

取值范围

不涉及

associate_instance_type

String

参数解释

关联资产类型

取值范围

不涉及

device_name

String

参数解释

关联资产名称

取值范围

不涉及

item

String

参数解释

聚合项

取值范围

不涉及

last_time

Long

参数解释

最近访问时间

取值范围

不涉及

agg_start_time

Long

参数解释

聚合开始时间

取值范围

不涉及

agg_end_time

Long

参数解释

聚合结束时间

取值范围

不涉及

ports

Array of ItemVO objects

参数解释

端口统计

取值范围

不涉及

region

String

参数解释

地区

取值范围

不涉及

request_byte

Double

参数解释

请求字节数

取值范围

不涉及

response_byte

Double

参数解释

响应字节数

取值范围

不涉及

sessions

Long

参数解释

会话数量

取值范围

不涉及

tags

String

参数解释

标签

取值范围

不涉及

src_ip

Array of ItemVO objects

参数解释

源IP

取值范围

不涉及

dst_ip

Array of ItemVO objects

参数解释

目的IP

取值范围

不涉及

protocol

String

参数解释

协议

取值范围

不涉及

表6 ItemVO

参数

参数类型

描述

key

String

参数解释

聚合项

取值范围

不涉及

name

String

参数解释

聚合项名称

取值范围

不涉及

value

Long

参数解释

统计值

取值范围

不涉及

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码

取值范围

不涉及

error_msg

String

参数解释

错误描述

取值范围

不涉及

请求示例

查询项目ID为a16df7cf1d094befa6bbc72cbf51e93a,防火墙ID为c598d612-8112-465c-bffd-863d4ce85a50,时间范围为7天,方向为出云方向,外联域名统计信息

https://{Endpoint}/v1/a16df7cf1d094befa6bbc72cbf51e93a/cfw/logs/flow-statistic?fw_instance_id=c598d612-8112-465c-bffd-863d4ce85a50&log_type=internet&direction=in2out&item=dst_host&range=2&size=1000

响应示例

状态码:200

OK

{
  "data" : {
    "records" : [ {
      "apps" : [ {
        "key" : "HTTP",
        "value" : 11
      } ],
      "item" : "www.test.com",
      "last_time" : 1751355533000,
      "ports" : [ {
        "key" : "8080",
        "value" : 11
      } ],
      "request_byte" : 5357,
      "response_byte" : 4862,
      "sessions" : 11
    } ],
    "total" : 1
  }
}

状态码:400

Bad Request

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

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.cfw.v1.region.CfwRegion;
import com.huaweicloud.sdk.cfw.v1.*;
import com.huaweicloud.sdk.cfw.v1.model.*;


public class ListFlowStatisticSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        CfwClient client = CfwClient.newBuilder()
                .withCredential(auth)
                .withRegion(CfwRegion.valueOf("<YOUR REGION>"))
                .build();
        ListFlowStatisticRequest request = new ListFlowStatisticRequest();
        try {
            ListFlowStatisticResponse response = client.listFlowStatistic(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcfw.v1.region.cfw_region import CfwRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcfw.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = CfwClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CfwRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListFlowStatisticRequest()
        response = client.list_flow_statistic(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    cfw "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := cfw.NewCfwClient(
        cfw.CfwClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListFlowStatisticRequest{}
	response, err := client.ListFlowStatistic(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码

相关文档