REST Resource: projects.locations.vpcFlowLogsConfigs

资源：VpcFlowLogsConfig

用于生成 VPC 流日志的配置。

JSON 表示法 
{
  "name": string,
  "metadataFields": [
    string
  ],
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "description": string,
  "state": enum (State),
  "aggregationInterval": enum (AggregationInterval),
  "flowSampling": number,
  "metadata": enum (Metadata),
  "filterExpr": string,

  // Union field target_resource can be only one of the following:
  "interconnectAttachment": string,
  "vpnTunnel": string
  // End of list of possible types for union field target_resource.
}
字段
name

string

标识符。配置的唯一名称，采用以下格式：projects/{projectId}/locations/global/vpcFlowLogsConfigs/{vpcFlowLogsConfigId}
metadataFields[]

string

可选。要包含在报告的 VPC 流日志中的自定义元数据字段。只有在“metadata”时才能指定已设为 CUSTOM_METADATA。
labels

map (key: string, value: string)

可选。用于表示用户提供的元数据的资源标签。

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
createTime

string (Timestamp format)

仅限输出。配置的创建时间。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

仅限输出。配置更新的时间。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
description

string

可选。用户提供的 VPC 流日志配置说明。最多 512 个字符。
state

enum (State)

可选。VPC 流日志配置的状态。默认值为“已启用”。创建新配置时，必须启用该配置。
aggregationInterval

enum (AggregationInterval)

可选。日志的汇总时间间隔。默认值为 INTERVAL_5_SEC。
flowSampling

number

可选。此字段的值必须为 (0, 1]。VPC 流日志的采样率，其中 1.0 表示报告所有收集的日志。不允许将采样率设置为 0.0。如果您想停用 VPC 流日志，请改用 state 字段。默认值为 1.0。
metadata

enum (Metadata)

可选。配置是否应将所有元数据字段添加到报告的 VPC 流日志中，不添加任何元数据字段，还是只添加其中的一部分字段。默认值为 INCLUDE_ALL_METADATA。
filterExpr

string

可选。用于定义应记录哪些 VPC 流日志的导出过滤条件。
联合字段 target_resource。对配置作用域资源的引用。也就是说，是指记录流量的范围。目标资源必须与配置属于同一项目。target_resource 只能是下列其中一项：
interconnectAttachment

string

系统将记录来自互连连接的流量。格式：projects/{projectId}/regions/{region}/interconnectAttachments/{name}
vpnTunnel

string

系统将记录 VPN 隧道的流量。格式：projects/{projectId}/区域/区域/vpnTunnels/{name}

州

确定此配置是否会生成日志。设置 state=DISABLED 将暂停此配置的日志生成。

枚举
STATE_UNSPECIFIED 如果未指定，则默认为“已启用”。
ENABLED 如果启用，此配置将生成日志。
DISABLED 设置为 DISABLED 时，此配置不会生成日志。

AggregationInterval

按 5 元组切换收集流日志的聚合时间间隔。

枚举
AGGREGATION_INTERVAL_UNSPECIFIED 如果未指定，则默认为 INTERVAL_5_SEC。
INTERVAL_5_SEC 以 5 秒为间隔汇总日志。
INTERVAL_30_SEC 按 30 秒间隔汇总日志。
INTERVAL_1_MIN 以 1 分钟的间隔汇总日志。
INTERVAL_5_MIN 以 5 分钟为间隔汇总日志。
INTERVAL_10_MIN 以 10 分钟的间隔汇总日志。
INTERVAL_15_MIN 以 15 分钟的间隔汇总日志。

元数据

配置要包含的日志字段。

枚举
METADATA_UNSPECIFIED 如果未指定，则默认为 INCLUDE_ALL_METADATA。
INCLUDE_ALL_METADATA 包含所有元数据字段。
EXCLUDE_ALL_METADATA 排除所有元数据字段。
CUSTOM_METADATA 仅包含自定义字段（在 metadataFields 中指定）。

方法

create

 创建新 VpcFlowLogsConfig。

delete

 删除特定的 VpcFlowLogsConfig。

get

 获取特定 VpcFlowLogsConfig 的详细信息。

list

 列出给定项目中的所有 VpcFlowLogsConfigs。

patch

 更新现有 VpcFlowLogsConfig。