文档首页/ 虚拟私有云 VPC/ API参考/ API V1/V2/ 流日志/ 查询流日志列表
更新时间：2025-06-28 GMT+08:00
查看PDF
分享

查询流日志列表

功能介绍

查询提交请求的租户的所有流日志列表，并根据过滤条件进行过滤。

调试

您可以在API Explorer中调试该接口。

URI

GET /v1/{project_id}/fl/flow_logs

样例：

GET https://{Endpoint}/v1/b2782e6708b8475c993e6064bc456bf8/fl/flow_logs?name=flowlog

参数说明请参见表1。

表1 参数说明

名称

是否必选

参数类型

说明

project_id

是

String

id

否

String
  • 功能说明：流日志ID

name

否

String
  • 流日志名称
  • 取值范围：0-64个字符，支持数字、字母、中文字符、_（下划线）、-（中划线）、.（点）

tenant_id

否

String
  • 功能说明：项目ID

description

否

String
  • 功能说明：流日志描述
  • 取值范围：0-255个字符，不能包含“<”和“>”

resource_type

否

String
  • 功能说明：流日志采集的资源类型
  • 取值范围：
    • port：单个网卡。
    • vpc：VPC内所有的网卡。
    • network：子网内所有的网卡。

resource_id

否

String
  • 功能说明：要采集的资源ID

traffic_type

否

String
  • 功能说明：流日志采集类型
  • 取值范围：
    • all：采集指定资源的全部流量。
    • accept：采集指定资源允许传入、传出的流量。
    • reject：采集指定资源拒绝传入、传出的流量。

log_group_id

否

String
  • 功能说明：日志组ID。

请在云日志服务中获取，详情请参见《云日志服务用户指南》。

log_topic_id

否

String
  • 功能说明：日志主题ID。

请在云日志服务中获取，详情请参见《云日志服务用户指南》。

log_store_type

否

String
  • 功能说明：流日志存储类型。
  • 取值范围：

    lts：存储类型为云日志服务（LTS）。

status

否

String

流日志状态

  • ACTIVE：开启
  • DOWN：关闭
  • ERROR：异常故障

limit

否

Integer

分页查询每页返回的记录个数，取值范围为0~intmax（2^31-1），默认值2000。

limit需要和marker配合使用，详细规则请见marker的参数说明。

marker

否

String

分页查询的起始资源ID，表示从指定资源的下一条记录开始查询。

marker需要和limit配合使用：

  • 若不传入marker和limit参数，查询结果返回第一页全部资源记录。
  • 若不传入marker参数，limit为10，查询结果返回第1~10条资源记录。
  • 若marker为第10条记录的资源ID，limit为10，查询结果返回第11~20条资源记录。
  • 若marker为第10条记录的资源ID，不传入limit参数，查询结果返回第11~2000条（limit默认值2000）资源记录。

请求参数

无

请求示例

GET https://{Endpoint}/v1/b2782e6708b8475c993e6064bc456bf8/fl/flow_logs?name=flowlog

响应参数

表2 响应参数

名称

参数类型

说明

flow_logs

Array of FlowLog objects

FlowLog对象列表，请参见表3。
表3 FlowLog对象说明

名称

参数类型

说明

id

String
  • 功能说明：流日志ID

name

String
  • 功能说明：流日志名称
  • 取值范围：0-64个字符，支持数字、字母、中文字符、_（下划线）、-（中划线）、.（点）

tenant_id

String
  • 功能说明：项目ID

description

String
  • 功能说明：流日志描述
  • 取值范围：0-255个字符，不能包含“<”和“>”

resource_type

String
  • 功能说明：流日志采集的资源类型
  • 取值范围：
    • port：单个网卡。
    • vpc：VPC内所有的网卡。
    • network：子网内所有的网卡。

resource_id

String
  • 功能说明：要采集的资源ID

traffic_type

String
  • 功能说明：流日志采集类型
  • 取值范围：
    • all：采集指定资源的全部流量。
    • accept：采集指定资源允许传入、传出的流量。
    • reject：采集指定资源拒绝传入、传出的流量。

log_group_id

String
  • 功能说明：日志组ID。

请在云日志服务中获取，详情请参见《云日志服务用户指南》。

log_topic_id

String
  • 功能说明：日志主题ID。

请在云日志服务中获取，详情请参见《云日志服务用户指南》。

log_store_type

String
  • 功能说明：流日志存储类型。
  • 取值范围：
    • lts：存储类型为云日志服务（LTS）。

admin_state

Boolean
  • 功能说明：是否开启流日志

status

String
  • 功能说明：流日志状态
  • 取值范围：
    • ACTIVE：开启
    • DOWN：关闭
    • ERROR：异常故障

created_at

String
  • 功能说明：流日志创建时间
  • 取值范围：UTC时间格式，yyyy-MM-ddTHH:mm:ss

updated_at

String
  • 功能说明：流日志更新时间
  • 取值范围：UTC时间格式，yyyy-MM-ddTHH:mm:ss

响应示例

{
    "flow_logs": [
        {
            "id": "35868d55-443e-4d5c-90a4-ac618dc45c1a",
            "name": "flowlog",
            "description": "just a test",
            "tenant_id": "b2782e6708b8475c993e6064bc456bf8",
            "resource_type": "port",
            "resource_id": "05c4052d-8d14-488f-aa00-19fea5a25fde",
            "traffic_type": "reject",
            "log_group_id": "05c4052d-8d14-488f-aa00-19fea5a25fff",
            "log_topic_id": "a9d7dee7-37d2-4cba-a208-a016252aaa63",
            "log_store_type": "lts",
            "created_at": "2019-01-14T11:03:02",
            "updated_at": "2019-01-14T11:03:02",
            "status": "ACTIVE",
            "admin_state": true
        }
    ]
}

状态码

请参见状态码。

错误码

请参考错误码。

父主题： 流日志

相关文档