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

ID。構成の一意の名前(形式: 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「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

updateTime

string (Timestamp format)

出力専用。構成が更新された時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

description

string

省略可。VPC フローログの構成のユーザー指定の説明。512 文字以内。

state

enum (State)

省略可。VPC フローログ構成の状態。デフォルト値は ENABLED です。新しい構成を作成する場合は、有効にする必要があります。

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}/regions/{region}/vpnTunnels/{name}

状態

この構成でログが生成されるかどうかを決定します。state=DISABLED を設定すると、この構成のログ生成が一時停止します。

列挙型
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 で指定)のみを含めます。

メソッド

create

新しい VpcFlowLogsConfig を作成します。

delete

特定の VpcFlowLogsConfig を削除します。

get

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

list

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

patch

既存の VpcFlowLogsConfig を更新します。