REST Resource: organizations.locations.vpcFlowLogsConfigs

Ressource: VpcFlowLogsConfig

Eine Konfiguration zum Generieren von VPC-Flusslogs.

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

string

Kennung. Eindeutiger 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}
metadataFields[]

string

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

map (key: string, value: string)

Optional. Ressourcenetiketten zur Darstellung der vom Nutzer bereitgestellten Metadaten.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem die Konfiguration erstellt wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Nur Ausgabe. Die Uhrzeit, zu der die Konfiguration aktualisiert wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
description

string

Optional. Die vom Nutzer bereitgestellte Beschreibung der VPC-Flusslogkonfiguration. Maximal 512 Zeichen.
state

enum (State)

Optional. 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 Protokollgenerierung für diese Konfiguration pausiert.
aggregationInterval

enum (AggregationInterval)

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

number

Optional. 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)

Optional. Konfiguriert, ob alle, keine oder eine Teilmenge der Metadatenfelder den gemeldeten VPC-Flusslogs hinzugefügt werden sollen. Der Standardwert ist INCLUDE_ALL_METADATA.
filterExpr

string

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

enum (CrossProjectMetadata)

Optional. 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.
targetResourceState

enum (TargetResourceState)

Nur Ausgabe. Beschreibt den Status der konfigurierten Zielressource zu Diagnosezwecken.
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}

Bundesland

Gibt an, ob für diese Konfiguration Logs generiert werden.

Enums
STATE_UNSPECIFIED Wenn keine Angabe erfolgt, wird standardmäßig ENABLED verwendet.
ENABLED Wenn diese Konfiguration auf „ENABLED“ gesetzt ist, werden Logs generiert.
DISABLED Wenn diese Option auf „DISABLED“ gesetzt ist, werden keine Logs generiert.

AggregationInterval

Legt das Aggregationsintervall für die Erfassung von Flusslogs nach 5‑Tupel fest.

Enums
AGGREGATION_INTERVAL_UNSPECIFIED Wenn nicht angegeben, wird standardmäßig INTERVAL_5_SEC verwendet.
INTERVAL_5_SEC Fassen Sie Logs in 5-Sekunden-Intervallen zusammen.
INTERVAL_30_SEC Logs in 30‑Sekunden-Intervallen zusammenfassen.
INTERVAL_1_MIN Logs in 1-Minuten-Intervallen zusammenfassen.
INTERVAL_5_MIN Logs in 5-Minuten-Intervallen zusammenfassen.
INTERVAL_10_MIN Logs in 10‑Minuten-Intervallen zusammenfassen.
INTERVAL_15_MIN Logs in 15‑Minuten-Intervallen zusammenfassen.

Metadaten

Konfiguriert, welche Logfelder einbezogen werden.

Enums
METADATA_UNSPECIFIED Wenn nicht angegeben, wird standardmäßig INCLUDE_ALL_METADATA verwendet.
INCLUDE_ALL_METADATA Alle Metadatenfelder einschließen.
EXCLUDE_ALL_METADATA Alle Metadatenfelder ausschließen
CUSTOM_METADATA Nur benutzerdefinierte Felder einbeziehen (in metadataFields angegeben).

CrossProjectMetadata

Gibt an, ob projektübergreifende Anmerkungen in die Logs aufgenommen werden sollen. Projektkonfigurationen haben immer CROSS_PROJECT_METADATA_DISABLED.

Enums
CROSS_PROJECT_METADATA_UNSPECIFIED Wenn keine Angabe erfolgt, wird der Standardwert CROSS_PROJECT_METADATA_ENABLED verwendet.
CROSS_PROJECT_METADATA_ENABLED Wenn CROSS_PROJECT_METADATA_ENABLED festgelegt ist, werden Metadaten aus anderen Projekten in die Logs aufgenommen.
CROSS_PROJECT_METADATA_DISABLED Wenn CROSS_PROJECT_METADATA_DISABLED festgelegt ist, werden Metadaten aus anderen Projekten nicht in die Logs aufgenommen.

TargetResourceState

Nur Ausgabe. Gibt zu Diagnosezwecken an, ob die Zielressource vorhanden ist.

Enums
TARGET_RESOURCE_STATE_UNSPECIFIED Nicht angegebener Status der Zielressource.
TARGET_RESOURCE_EXISTS Gibt an, dass die Zielressource vorhanden ist.
TARGET_RESOURCE_DOES_NOT_EXIST Gibt an, dass die Zielressource nicht vorhanden ist.

Methoden

create

 Erstellt einen neuen VpcFlowLogsConfig

delete

 Löscht einen bestimmten VpcFlowLogsConfig.

get

 Ruft die Details eines bestimmten VpcFlowLogsConfig ab.

list

 Listet alle VpcFlowLogsConfigs in einer bestimmten Organisation auf.

patch

 Aktualisiert eine vorhandene VpcFlowLogsConfig.