REST Resource: organizations.locations.vpcFlowLogsConfigs

Risorsa: VpcFlowLogsConfig

Una configurazione per generare log di flusso VPC.

Rappresentazione 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,
  "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.
}
Campi
name

string

Identificatore. Nome univoco della configurazione. Il nome può avere uno dei seguenti formati:

  • Per le configurazioni a livello di progetto: projects/{projectId}/locations/global/vpcFlowLogsConfigs/{vpcFlowLogsConfigId}

  • Per le configurazioni a livello di organizzazione: organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpcFlowLogsConfigId}
metadataFields[]

string

Facoltativo. Campi di metadati personalizzati da includere nei log di flusso VPC segnalati. Può essere specificato solo se "metadata" è stato impostato su CUSTOM_METADATA.
labels

map (key: string, value: string)

Facoltativo. Etichette delle risorse per rappresentare i metadati forniti dagli utenti.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Solo output. L'ora in cui è stata creata la configurazione.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Solo output. L'ora in cui è stata aggiornata la configurazione.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
description

string

Facoltativo. La descrizione fornita dall'utente della configurazione dei log di flusso VPC. Massimo 512 caratteri.
state

enum (State)

Facoltativo. Lo stato della configurazione dei log di flusso VPC. Il valore predefinito è ENABLED. Quando crei una nuova configurazione, questa deve essere attivata. Se imposti state=DISABLED, la generazione dei log per questa configurazione verrà sospesa.
aggregationInterval

enum (AggregationInterval)

Facoltativo. L'intervallo di aggregazione per i log. Il valore predefinito è INTERVAL_5_SEC.
flowSampling

number

Facoltativo. Il valore del campo deve essere compreso tra 0 e 1. La frequenza di campionamento dei log di flusso VPC, dove 1.0 indica che vengono segnalati tutti i log raccolti. Non è consentito impostare la frequenza di campionamento su 0,0. Se vuoi disattivare i log di flusso VPC, utilizza il campo stato. Il valore predefinito è 1.0.
metadata

enum (Metadata)

Facoltativo. Configura se tutti, nessuno o un sottoinsieme di campi di metadati devono essere aggiunti ai log di flusso VPC segnalati. Il valore predefinito è INCLUDE_ALL_METADATA.
filterExpr

string

Facoltativo. Filtro di esportazione utilizzato per definire quali log di flusso VPC devono essere registrati.
crossProjectMetadata

enum (CrossProjectMetadata)

Facoltativo. Determina se includere le annotazioni tra progetti nei log. Questo campo è disponibile solo per le configurazioni dell'organizzazione. Se non specificato nelle configurazioni dell'organizzazione, verrà impostato su CROSS_PROJECT_METADATA_ENABLED.
targetResourceState

enum (TargetResourceState)

Solo output. Descrive lo stato della risorsa di destinazione configurata a scopo diagnostico.
Campo unione target_resource. Riferimento alla risorsa dell'ambito di configurazione. ovvero l'ambito da cui viene registrato il traffico. La risorsa di destinazione deve appartenere allo stesso progetto della configurazione. Questo campo non è supportato per le configurazioni a livello di organizzazione. target_resource può essere solo uno dei seguenti:
network

string

Il traffico verrà registrato da VM, tunnel VPN e collegamenti di interconnessione all'interno della rete. Formato: projects/{projectId}/global/networks/{name}
subnet

string

Il traffico verrà registrato dalle VM all'interno della subnet. Formato: projects/{projectId}/regions/{region}/subnetworks/{name}
interconnectAttachment

string

Il traffico verrà registrato dall'allegato di interconnessione. Formato: projects/{projectId}/regions/{region}/interconnectAttachments/{name}
vpnTunnel

string

Il traffico verrà registrato dal tunnel VPN. Formato: projects/{projectId}/regions/{region}/vpnTunnels/{name}

Stato

Determina se questa configurazione genererà log.

Enum
STATE_UNSPECIFIED Se non specificato, il valore predefinito è ENABLED.
ENABLED Se impostata su ENABLED, questa configurazione genererà log.
DISABLED Se l'opzione è DISABILITATA, questa configurazione non genererà log.

AggregationInterval

Attiva/disattiva l'intervallo di aggregazione per la raccolta dei log di flusso in base alla 5-tupla.

Enum
AGGREGATION_INTERVAL_UNSPECIFIED Se non specificato, il valore predefinito è INTERVAL_5_SEC.
INTERVAL_5_SEC Aggrega i log a intervalli di 5 secondi.
INTERVAL_30_SEC Aggrega i log a intervalli di 30 secondi.
INTERVAL_1_MIN Aggrega i log a intervalli di 1 minuto.
INTERVAL_5_MIN Aggrega i log a intervalli di 5 minuti.
INTERVAL_10_MIN Aggrega i log a intervalli di 10 minuti.
INTERVAL_15_MIN Aggrega i log a intervalli di 15 minuti.

Metadati

Configura i campi di log da includere.

Enum
METADATA_UNSPECIFIED Se non specificato, il valore predefinito è INCLUDE_ALL_METADATA.
INCLUDE_ALL_METADATA Includi tutti i campi dei metadati.
EXCLUDE_ALL_METADATA Escludi tutti i campi dei metadati.
CUSTOM_METADATA Includi solo i campi personalizzati (specificati in metadataFields).

CrossProjectMetadata

Determina se includere le annotazioni tra progetti nei log. Le configurazioni del progetto avranno sempre CROSS_PROJECT_METADATA_DISABLED.

Enum
CROSS_PROJECT_METADATA_UNSPECIFIED Se non specificato, il valore predefinito è CROSS_PROJECT_METADATA_ENABLED.
CROSS_PROJECT_METADATA_ENABLED Quando CROSS_PROJECT_METADATA_ENABLED, i metadati di altri progetti verranno inclusi nei log.
CROSS_PROJECT_METADATA_DISABLED Quando CROSS_PROJECT_METADATA_DISABLED, i metadati di altri progetti non vengono inclusi nei log.

TargetResourceState

Solo output. Indica se la risorsa di destinazione esiste, a scopo diagnostico.

Enum
TARGET_RESOURCE_STATE_UNSPECIFIED Stato della risorsa di destinazione non specificato.
TARGET_RESOURCE_EXISTS Indica che la risorsa di destinazione esiste.
TARGET_RESOURCE_DOES_NOT_EXIST Indica che la risorsa di destinazione non esiste.

Metodi

create

 Crea un nuovo VpcFlowLogsConfig.

delete

 Elimina un VpcFlowLogsConfig specifico.

get

 Recupera i dettagli di un VpcFlowLogsConfig specifico.

list

 Elenca tutti i VpcFlowLogsConfigs in una determinata organizzazione.

patch

 Aggiorna un VpcFlowLogsConfig esistente.