REST Resource: organizations.locations.vpcFlowLogsConfigs

リソース: VpcFlowLogsConfig

VPC Flow Logs を生成する構成。

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

ID。構成の一意の名前。名前は次のいずれかの形式になります。

  • プロジェクト レベルの構成の場合: 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 フローログに、すべてのメタデータ フィールドを追加する、そのサブセットを追加する、またはいずれも追加しないかどうかを設定します。デフォルト値は INCLUDE_ALL_METADATA です。
filterExpr

string

省略可。どの VPC フローログをロギングするかを定義するために使用されるエクスポート フィルタ。
crossProjectMetadata

enum (CrossProjectMetadata)

省略可。ログにクロス プロジェクト アノテーションを含めるかどうかを決定します。このフィールドは、組織構成でのみ使用できます。組織構成で指定されていない場合、CROSS_PROJECT_METADATA_ENABLED に設定されます。
targetResourceState

enum (TargetResourceState)

出力専用。診断用に構成されたターゲット リソースの状態を記述します。
共用体フィールド target_resource。構成スコープのリソースへの参照。つまり、トラフィックがログに記録されるスコープです。ターゲット リソースは、構成と同じプロジェクトに属している必要があります。このフィールドは、組織レベルの構成ではサポートされていません。target_resource は次のいずれかになります。
network

string

トラフィックは、ネットワーク内の VM、VPN トンネル、相互接続のアタッチメントからログに記録されます。形式: projects/{projectId}/global/networks/{name}
subnet

string

トラフィックはサブネットワーク内の VM からログに記録されます。形式: projects/{projectId}/regions/{region}/subnetworks/{name}
interconnectAttachment

string

トラフィックは相互接続のアタッチメントからログに記録されます。形式: projects/{projectId}/regions/{region}/interconnectAttachments/{name}
vpnTunnel

string

トラフィックは VPN トンネルからログに記録されます。形式: projects/{projectId}/regions/{region}/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 を更新します。