更新时间:2024-10-11 GMT+08:00

创建流日志

功能介绍

创建流日志。

流日志功能可以记录虚拟私有云中的流量信息,帮助您检查和优化安全组和网络ACL控制规则、监控网络流量、进行网络攻击分析等。

VPC流日志功能需要与云日志服务LTS结合使用,请先在云日志服务中创建日志组和日志主题,然后再创建VPC流日志。

流日志功能目前仅对“华北-北京四、华东-上海一、华南-广州、西南-贵阳一、中国-香港、亚太-曼谷、亚太-新加坡、拉美-墨西哥城二、非洲-约翰内斯堡”区域开放。

URI

POST /v1/{project_id}/fl/flow_logs

参数说明请参见表1

表1 参数说明

名称

是否必选

参数类型

说明

project_id

String

项目ID,请参见获取项目ID

请求参数

表2 请求参数

名称

是否必选

参数类型

说明

flow_log

flow_log object

FlowLog对象,请参见表3

表3 FlowLog对象说明

名称

是否必选

参数类型

说明

name

String

  • 功能说明:流日志名称
  • 取值范围:0-64个字符,支持数字、字母、中文字符、_(下划线)、-(中划线)、.(点)

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。

请求示例

  • 创建流日志,日志采集的资源类型为port,资源id为05c4052d-8d14-488f-aa00-19fea5a25fde,日志采集类型为reject,日志组id为05c4052d-8d14-488f-aa00-19fea5a25fdd,日志主题id为a9d7dee7-37d2-4cba-a208-a016252aaa63。
    POST https://{Endpoint}/v1/b2782e6708b8475c993e6064bc456bf8/fl/flow_logs
    
    {
        "flow_log": {
            "name": "flowlog",
            "description": "just a test",
            "resource_type": "port",
            "resource_id": "05c4052d-8d14-488f-aa00-19fea5a25fde",
            "traffic_type": "reject",
            "log_group_id": "05c4052d-8d14-488f-aa00-19fea5a25fdd",
            "log_topic_id": "a9d7dee7-37d2-4cba-a208-a016252aaa63"
        }
    }

响应参数

表4 响应参数

名称

参数类型

说明

flow_log

flow_log object

FlowLog对象,请参见表5

表5 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_log": {
        "id": "f49f00f1-0f15-470a-a8c5-4e879e461c8d",
        "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-19fea5a25fdd",
        "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",
        "admin_state": true,
        "status": "ACTIVE"
    }
}

状态码

请参见状态码

错误码

请参考错误码