REST Resource: projects.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 Flow Logs に含めるカスタム メタデータ フィールド。「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 Flow Logs 構成のユーザー指定の説明。512 文字以内で指定します。
state

enum (State)

省略可。VPC Flow Logs 構成の状態。デフォルト値は ENABLED です。新しい構成を作成する場合は、有効にする必要があります。state=DISABLED に設定すると、この構成のログ生成が一時停止します。
aggregationInterval

enum (AggregationInterval)

省略可。ログの集約間隔。デフォルト値は INTERVAL_5_SEC です。
flowSampling

number

省略可。フィールドの値は [0, 1] 内にある値にします。VPC Flow Logs のサンプリング レート。1.0 は収集されたすべてのログが報告されることを意味します。サンプリング レートを 0.0 に設定することはできません。VPC Flow Logs を無効にする場合には、代わりに state フィールドを使用します。デフォルト値は 1.0 です。
metadata

enum (Metadata)

省略可。報告される VPC Flow Logs にメタデータ フィールドをすべて追加する、そのサブセットを追加する、または追加しないのいずれかを構成します。デフォルト値は INCLUDE_ALL_METADATA です。
filterExpr

string

省略可。ロギング対象の VPC Flow Logs を定義するために使用されるエクスポート フィルタ。
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}

メソッド

create

 新しい VpcFlowLogsConfig を作成します。

delete

 特定の VpcFlowLogsConfig を削除します。

get

 特定の VpcFlowLogsConfig の詳細を取得します。

list

 指定されたプロジェクト内のすべての VpcFlowLogsConfigs を一覧表示します。

patch

 既存の VpcFlowLogsConfig を更新します。

queryOrgVpcFlowLogsConfigs

 QueryOrgVpcFlowLogsConfigs は、指定されたプロジェクトに適用されるすべての組織レベルの VPC Flow Logs 構成のリストを返します。