REST Resource: organizations.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,
  "crossProjectMetadata": enum (CrossProjectMetadata),
  "targetResourceState": enum (TargetResourceState),

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

string

标识符。配置的唯一名称。名称可以采用以下任一种形式：

  • 对于项目级配置：projects/{projectId}/locations/global/vpcFlowLogsConfigs/{vpcFlowLogsConfigId}

  • 对于组织级配置：organizations/{organization_id}/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)

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

采用 RFC 3339 标准，生成的输出将始终在末尾带 Z，并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

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

采用 RFC 3339 标准，生成的输出将始终在末尾带 Z，并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"
description

string

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

enum (State)

可选。VPC 流日志配置的状态。默认值为 ENABLED。创建新配置时，必须启用该字段。将 state 设置为 DISABLED 将暂停相应配置的日志生成。
aggregationInterval

enum (AggregationInterval)

可选。日志的聚合时间间隔。默认值为 INTERVAL_5_SEC。
flowSampling

number

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

enum (Metadata)

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

string

可选。用于定义应记录哪些 VPC 流日志的导出过滤条件。
crossProjectMetadata

enum (CrossProjectMetadata)

可选。确定是否在日志中包含跨项目注释。此字段仅适用于组织配置。如果未在组织配置中指定，则将设置为 CROSS_PROJECT_METADATA_ENABLED。
targetResourceState

enum (TargetResourceState)

仅限输出。描述配置的目标资源的状态，以用于诊断。
联合字段 target_resource。对配置范围资源的引用。也就是说，流量记录的范围。目标资源必须与配置属于同一项目。组织级配置不支持此字段。target_resource 只能是下列其中一项：
network

string

流量将从网络中的虚拟机、VPN 隧道和互连连接记录。格式：projects/{projectId}/global/networks/{name}
subnet

string

流量将从子网内的虚拟机记录。格式：projects/{projectId}/区域/区域/subnetworks/{name}
interconnectAttachment

string

流量将从互连连接记录。格式：projects/{projectId}/区域/区域/interconnectAttachments/{name}
vpnTunnel

string

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

州

确定此配置是否会生成日志。

枚举
STATE_UNSPECIFIED 如果未指定，则默认为 ENABLED。
ENABLED 当值为 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 中指定）。

CrossProjectMetadata

确定是否在日志中包含跨项目注释。项目配置将始终具有 CROSS_PROJECT_METADATA_DISABLED。

枚举
CROSS_PROJECT_METADATA_UNSPECIFIED 如果未指定，则默认值为 CROSS_PROJECT_METADATA_ENABLED。
CROSS_PROJECT_METADATA_ENABLED 如果为 CROSS_PROJECT_METADATA_ENABLED，则日志中将包含来自其他项目的元数据。
CROSS_PROJECT_METADATA_DISABLED 如果设置为 CROSS_PROJECT_METADATA_DISABLED，日志中将不包含来自其他项目的元数据。

TargetResourceState

仅限输出。指示目标资源是否存在，用于诊断。

枚举
TARGET_RESOURCE_STATE_UNSPECIFIED 未指定的目标资源状态。
TARGET_RESOURCE_EXISTS 表示目标资源存在。
TARGET_RESOURCE_DOES_NOT_EXIST 表示目标资源不存在。

方法

create

 创建新 VpcFlowLogsConfig。

delete

 删除特定的 VpcFlowLogsConfig。

get

 获取特定 VpcFlowLogsConfig 的详细信息。

list

 列出给定组织中的所有 VpcFlowLogsConfigs。

patch

 更新现有 VpcFlowLogsConfig。