Method: projects.locations.vpcFlowLogsConfigs.showEffectiveFlowLogsConfigs

vpcFlowLogsConfigs.showEffectiveFlowLogsConfigs gibt eine Liste aller VPC-Flusslogkonfigurationen zurück, die für eine bestimmte Ressource gelten.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Die übergeordnete Ressource der „VpcFlowLogsConfig“ im folgenden Format: projects/{projectId}/locations/global

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource parent erforderlich:

  • networkmanagement.vpcflowlogsconfigs.list

Suchparameter

Parameter
resource

string

Erforderlich. Die Ressource, für die die effektive VPC-Flusslogkonfiguration abgerufen werden soll. Die Ressource muss zum selben Projekt wie das übergeordnete Element gehören. Die Ressource muss ein Netzwerk, ein Subnetzwerk, ein Interconnect-Anhang, ein VPN-Tunnel oder ein Projekt sein.

pageSize

integer

Optional. Anzahl der zurückzugebenden EffectiveVpcFlowLogsConfigs. Der Standardwert ist 30.

pageToken

string

Optional. Seitentoken aus einer früheren Anfrage, wie in nextPageToken zurückgegeben.

filter

string

Optional. Listet die EffectiveVpcFlowLogsConfigs auf, die dem Filterausdruck entsprechen. In einem Filterausdruck müssen die unterstützten logischen CEL-Operatoren verwendet werden.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwort für die Methode vpcFlowLogsConfigs.showEffectiveFlowLogsConfigs.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung
{
  "effectiveFlowLogsConfigs": [
    {
      object (EffectiveVpcFlowLogsConfig)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Felder
effectiveFlowLogsConfigs[]

object (EffectiveVpcFlowLogsConfig)

Liste der effektiven VPC-Flusslogkonfigurationen.

nextPageToken

string

Seitentoken zum Abrufen des nächsten Konfigurationssatzes.

unreachable[]

string

Standorte, die nicht erreicht werden konnten (bei Abfrage aller Standorte mit -).

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie unter Authentication Overview.

EffectiveVpcFlowLogsConfig

Eine Konfiguration zum Generieren einer Antwort für die Anfrage „GetEffectiveVpcFlowLogsConfig“.

JSON-Darstellung
{
  "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)
}
Felder
name

string

Spezifischer Name der Konfiguration. Der Name kann eines der folgenden Formate haben:

  • Für Konfigurationen auf Projektebene: projects/{projectId}/locations/global/vpcFlowLogsConfigs/{vpcFlowLogsConfigId}

  • Für Konfigurationen auf Organisationsebene: organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpcFlowLogsConfigId}

  • Bei einer Compute-Konfiguration ist der Name der Pfad des Subnetzes: projects/{projectId}/regions/{region}/subnetworks/{subnet_id}

metadataFields[]

string

Benutzerdefinierte Metadatenfelder, die in den gemeldeten VPC-Flusslogs enthalten sein sollen. Kann nur angegeben werden, wenn „metadata“ auf CUSTOM_METADATA festgelegt wurde.

state

enum (State)

Der Status der VPC-Flusslogkonfiguration. Der Standardwert ist ENABLED. Wenn Sie eine neue Konfiguration erstellen, muss sie aktiviert werden. Wenn Sie „state=DISABLED“ festlegen, wird die Loggenerierung für diese Konfiguration pausiert.

aggregationInterval

enum (AggregationInterval)

Das Aggregationsintervall für die Logs. Der Standardwert ist INTERVAL_5_SEC.

flowSampling

number

Der Wert des Feldes muss im Bereich (0, 1] liegen. Die Abtastrate für VPC-Flusslogs.1,0 bedeutet, dass alle erfassten Logs gemeldet werden. Das Festlegen der Abtastrate auf 0,0 ist nicht zulässig. Wenn Sie VPC-Flusslogs deaktivieren möchten, verwenden Sie stattdessen das Feld „state“. Der Standardwert ist 1,0.

metadata

enum (Metadata)

Konfiguriert, ob alle, keine oder eine Teilmenge von Metadatenfeldern den gemeldeten VPC-Flusslogs hinzugefügt werden sollen. Der Standardwert ist INCLUDE_ALL_METADATA.

filterExpr

string

Exportfilter, mit dem definiert wird, welche VPC-Flusslogs protokolliert werden sollen.

crossProjectMetadata

enum (CrossProjectMetadata)

Gibt an, ob projektübergreifende Anmerkungen in die Logs aufgenommen werden sollen. Dieses Feld ist nur für Organisationskonfigurationen verfügbar. Wenn nicht in den Organisationskonfigurationen angegeben, wird CROSS_PROJECT_METADATA_ENABLED festgelegt.

Union-Feld target_resource. Referenz auf die Ressource des Konfigurationsbereichs. Das ist der Bereich, aus dem Traffic protokolliert wird. Die Zielressource muss zum selben Projekt wie die Konfiguration gehören. Dieses Feld wird für Konfigurationen auf Organisationsebene nicht unterstützt. Für target_resource ist nur einer der folgenden Werte zulässig:
network

string

Der Traffic wird von VMs, VPN-Tunneln und Interconnect-Anhängen im Netzwerk protokolliert. Format: projects/{projectId}/global/networks/{name}

subnet

string

Der Traffic wird von VMs im Subnetzwerk protokolliert. Format: projects/{projectId}/regions/{region}/subnetworks/{name}

interconnectAttachment

string

Der Traffic wird über das Interconnect-Attachment protokolliert. Format: projects/{projectId}/regions/{region}/interconnectAttachments/{name}

vpnTunnel

string

Der Traffic wird über den VPN-Tunnel protokolliert. Format: projects/{projectId}/regions/{region}/vpnTunnels/{name}

scope

enum (Scope)

Gibt den Bereich der Konfiguration an, z.B. SUBNET, NETWORK, ORGANIZATION).

Umfang

Der Bereich für diese Flusslogkonfiguration.

Enums
SCOPE_UNSPECIFIED Der Umfang ist nicht angegeben.
SUBNET Die Zielressource ist ein Subnetz (Network Management API).
COMPUTE_API_SUBNET Die Zielressource ist ein Subnetz und die Konfiguration stammt von der Compute API.
NETWORK Die Zielressource ist ein Netzwerk.
VPN_TUNNEL Die Zielressource ist ein VPN-Tunnel.
INTERCONNECT_ATTACHMENT Die Zielressource ist ein Interconnect-Anhang.
ORGANIZATION Die Konfiguration gilt für die gesamte Organisation.