REST Resource: projects.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,

  // 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.
}
Felder
name

string

Kennung. Eindeutiger Name der Konfiguration im folgenden Format: projects/{projectId}/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 ist.

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. Die Zeit, zu der die Konfiguration erstellt wurde.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

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

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

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 sein.

aggregationInterval

enum (AggregationInterval)

Optional. Das Aggregationsintervall für die Protokolle. 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. Die Abtastrate darf nicht auf 0,0 festgelegt werden. Wenn Sie VPC-Flusslogs deaktivieren möchten, verwenden Sie stattdessen das Feld „Status“. Der Standardwert ist 1,0.

metadata

enum (Metadata)

Optional. Hiermit wird konfiguriert, ob alle, keine oder eine Teilmenge der Metadatenfelder den gemeldeten VPC-Flusslogs hinzugefügt werden soll. Der Standardwert ist INCLUDE_ALL_METADATA.

filterExpr

string

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

Union-Feld target_resource. Verweis auf die Ressource des Konfigurationsumfangs. Das ist der Bereich, in dem der Traffic protokolliert wird. Die Zielressource muss zum selben Projekt wie die Konfiguration gehören. Für target_resource ist nur einer der folgenden Werte zulässig:
interconnectAttachment

string

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

vpnTunnel

string

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

Bundesland

Bestimmt, ob für diese Konfiguration Protokolle generiert werden. Wenn Sie „state=DISABLED“ festlegen, wird die Protokollerstellung für diese Konfiguration pausiert.

Enums
STATE_UNSPECIFIED Wenn keine Angabe erfolgt, wird standardmäßig „AKTIVIERT“ verwendet.
ENABLED Wenn diese Konfiguration aktiviert ist, werden Protokolle generiert.
DISABLED Wenn diese Option deaktiviert ist, werden keine Protokolle generiert.

AggregationInterval

Damit wird das Aggregationsintervall für die Erfassung von Flussprotokollen nach 5-Tupel umgeschaltet.

Enums
AGGREGATION_INTERVAL_UNSPECIFIED Wenn keine Angabe erfolgt, wird standardmäßig INTERVAL_5_SEC verwendet.
INTERVAL_5_SEC Logs in 5-Sekunden-Intervallen zusammenfassen.
INTERVAL_30_SEC Logs in 30-Sekunden-Intervallen zusammenfassen.
INTERVAL_1_MIN Logs werden in Intervallen von 1 Minute zusammengefasst.
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

Hier wird konfiguriert, welche Protokollfelder eingeschlossen werden.

Enums
METADATA_UNSPECIFIED Wenn keine Angabe erfolgt, wird standardmäßig INCLUDE_ALL_METADATA verwendet.
INCLUDE_ALL_METADATA Fügen Sie alle Metadatenfelder hinzu.
EXCLUDE_ALL_METADATA Schließen Sie alle Metadatenfelder aus.
CUSTOM_METADATA Fügen Sie nur benutzerdefinierte Felder hinzu, die in „metadataFields“ angegeben sind.

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 einem bestimmten Projekt auf.

patch

Aktualisiert eine vorhandene Buchung (VpcFlowLogsConfig).