Method: projects.locations.vpcFlowLogsConfigs.showEffectiveFlowLogsConfigs

vpcFlowLogsConfigs.showEffectiveFlowLogsConfigs は、指定されたリソースに適用可能なすべての VPC Flow Logs 構成のリストを返します。

HTTP リクエスト

GET https://networkmanagement.googleapis.com/v1beta1/{parent=projects/*/locations/*}/vpcFlowLogsConfigs:showEffectiveFlowLogsConfigs

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。VpcFlowLogsConfig の親リソース。projects/{projectId}/locations/global の形式で指定します。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • networkmanagement.vpcflowlogsconfigs.list

クエリ パラメータ

パラメータ
resource

string

必須。有効な VPC Flow Logs 構成を取得するリソース。リソースは、親と同じプロジェクトに属している必要があります。リソースは、ネットワーク、サブネットワーク、相互接続アタッチメント、VPN トンネル、またはプロジェクトである必要があります。
pageSize

integer

省略可。返される EffectiveVpcFlowLogsConfigs の数。デフォルトは 30 です。
pageToken

string

省略可。以前のクエリのページトークン。nextPageToken で返されます。
filter

string

省略可。フィルタ式に一致する EffectiveVpcFlowLogsConfigs を一覧表示します。フィルタ式では、サポートされている CEL 論理演算子を使用する必要があります。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

vpcFlowLogsConfigs.showEffectiveFlowLogsConfigs メソッドに対するレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "effectiveFlowLogsConfigs": [
    {
      object (EffectiveVpcFlowLogsConfig)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
フィールド
effectiveFlowLogsConfigs[]

object (EffectiveVpcFlowLogsConfig)

有効な VPC Flow Logs 構成のリスト。
nextPageToken

string

次の構成セットを取得するためのページトークン。
unreachable[]

string

到達できなかったロケーション（- ですべてのロケーションをクエリする場合）。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。

EffectiveVpcFlowLogsConfig

GetEffectiveVpcFlowLogsConfig リクエストのレスポンスを生成する構成。

JSON 表現 
{
  "name": string,
  "metadataFields": [
    string
  ],
  "state": enum (State),
  "aggregationInterval": enum (AggregationInterval),
  "flowSampling": number,
  "metadata": enum (Metadata),
  "filterExpr": string,
  "crossProjectMetadata": enum (CrossProjectMetadata),

  // 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.
  "scope": enum (Scope)
}
フィールド
name

string

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

  • プロジェクト レベルの構成の場合: projects/{projectId}/locations/global/vpcFlowLogsConfigs/{vpcFlowLogsConfigId}

  • 組織レベルの構成の場合: organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpcFlowLogsConfigId}

  • Compute 構成の場合、名前はサブネットのパスになります。projects/{projectId}/regions/{region}/subnetworks/{subnet_id}
metadataFields[]

string

報告される VPC Flow Logs に含めるカスタム メタデータ フィールド。metadata が CUSTOM_METADATA に設定されている場合のみ指定できます。
state

enum (State)

VPC フローログ構成の状態。デフォルト値は 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 フローログに、すべてのメタデータ フィールドを追加する、そのサブセットを追加する、またはいずれも追加しないかどうかを構成します。デフォルト値は INCLUDE_ALL_METADATA です。
filterExpr

string

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

enum (CrossProjectMetadata)

ログにプロジェクト間のアノテーションを含めるかどうかを決定します。このフィールドは、組織構成でのみ使用できます。組織構成で指定されていない場合、CROSS_PROJECT_METADATA_ENABLED に設定されます。
共用体フィールド 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}
scope

enum (Scope)

構成のスコープ（SUBNET、NETWORK、ORGANIZATION など）。

範囲

このフローログ構成のスコープ。

列挙型
SCOPE_UNSPECIFIED スコープが指定されていません。
SUBNET ターゲット リソースはサブネット（Network Management API）。
COMPUTE_API_SUBNET ターゲット リソースがサブネットで、構成が Compute API から取得された。
NETWORK ターゲット リソースはネットワークです。
VPN_TUNNEL ターゲット リソースは VPN トンネルです。
INTERCONNECT_ATTACHMENT ターゲット リソースはインターコネクト アタッチメントです。
ORGANIZATION 構成は組織全体に適用されます。