REST Resource: organizations.locations.vpcFlowLogsConfigs

Ressource : VpcFlowLogsConfig

Configuration permettant de générer des journaux de flux VPC.

Représentation 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.
}
Champs
name

string

Identifiant. Nom unique de la configuration. Le nom peut se présenter sous l'une des formes suivantes :

  • Pour les configurations au niveau du projet : projects/{projectId}/locations/global/vpcFlowLogsConfigs/{vpcFlowLogsConfigId}

  • Pour les configurations au niveau de l'organisation : organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpcFlowLogsConfigId}
metadataFields[]

string

Facultatif. Champs de métadonnées personnalisés à inclure dans les journaux de flux VPC signalés. Ne peut être spécifié que si "metadata" a été défini sur CUSTOM_METADATA.
labels

map (key: string, value: string)

Facultatif. Libellés de ressources permettant de représenter les métadonnées fournies par l'utilisateur.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Uniquement en sortie. Heure de création de la configuration.

Utilise la norme RFC 3339, où le résultat généré est toujours normalisé avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle la configuration a été mise à jour.

Utilise la norme RFC 3339, où le résultat généré est toujours normalisé avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
description

string

Facultatif. Description de la configuration des journaux de flux VPC fournie par l'utilisateur. 512 caractères au maximum.
state

enum (State)

Facultatif. État de la configuration des journaux de flux VPC. La valeur par défaut est ENABLED. Lorsque vous créez une configuration, vous devez l'activer. Si vous définissez l'état sur "DISABLED", la génération de journaux pour cette configuration sera suspendue.
aggregationInterval

enum (AggregationInterval)

Facultatif. Intervalle d'agrégation des journaux. La valeur par défaut est INTERVAL_5_SEC.
flowSampling

number

Facultatif. La valeur du champ doit être comprise entre (0 et 1]. Taux d'échantillonnage des journaux de flux VPC (1.0 signifie que tous les journaux collectés sont signalés). Il n'est pas autorisé de définir le taux d'échantillonnage sur 0,0. Si vous souhaitez désactiver les journaux de flux VPC, utilisez plutôt le champ "state". La valeur par défaut est 1.0.
metadata

enum (Metadata)

Facultatif. Configure si tous les champs de métadonnées, aucun ou un sous-ensemble doivent être ajoutés aux journaux de flux VPC signalés. La valeur par défaut est INCLUDE_ALL_METADATA.
filterExpr

string

Facultatif. Filtre d'exportation utilisé pour définir les journaux de flux VPC à enregistrer.
crossProjectMetadata

enum (CrossProjectMetadata)

Facultatif. Détermine s'il faut inclure les annotations inter-projets dans les journaux. Ce champ n'est disponible que pour les configurations d'organisation. Si elle n'est pas spécifiée dans les configurations de l'organisation, la valeur est définie sur CROSS_PROJECT_METADATA_ENABLED.
targetResourceState

enum (TargetResourceState)

Uniquement en sortie. Décrit l'état de la ressource cible configurée à des fins de diagnostic.
Champ d'union target_resource. Référence à la ressource du champ d'application de la configuration. Autrement dit, il s'agit du champ d'application à partir duquel le trafic est consigné. La ressource cible doit appartenir au même projet que la configuration. Ce champ n'est pas disponible pour les configurations au niveau de l'organisation. target_resource ne peut être qu'un des éléments suivants :
network

string

Le trafic sera consigné à partir des VM, des tunnels VPN et des rattachements d'interconnexion du réseau. Format : projects/{projectId}/global/networks/{name}
subnet

string

Le trafic sera consigné à partir des VM du sous-réseau. Format : projects/{projectId}/regions/{region}/subnetworks/{name}
interconnectAttachment

string

Le trafic sera consigné à partir de l'attachement Interconnect. Format : projects/{projectId}/regions/{region}/interconnectAttachments/{name}
vpnTunnel

string

Le trafic sera consigné à partir du tunnel VPN. Format : projects/{projectId}/regions/{region}/vpnTunnels/{name}

État

Détermine si cette configuration générera des journaux.

Énumérations
STATE_UNSPECIFIED Si aucune valeur n'est spécifiée, la valeur par défaut est "ENABLED" (ACTIVÉ).
ENABLED Lorsque cette configuration est ACTIVÉE, elle génère des journaux.
DISABLED Lorsque ce paramètre est défini sur "DISABLED" (DÉSACTIVÉ), cette configuration ne génère pas de journaux.

AggregationInterval

Active ou désactive l'intervalle d'agrégation pour la collecte des journaux de flux par 5-tuple.

Énumérations
AGGREGATION_INTERVAL_UNSPECIFIED Si aucune valeur n'est spécifiée, la valeur par défaut est INTERVAL_5_SEC.
INTERVAL_5_SEC Agrégez les journaux par intervalles de cinq secondes.
INTERVAL_30_SEC Agrégez les journaux par intervalles de 30 secondes.
INTERVAL_1_MIN Agrège les journaux par intervalles d'une minute.
INTERVAL_5_MIN Agrégez les journaux par intervalles de cinq minutes.
INTERVAL_10_MIN Agrège les journaux par intervalles de 10 minutes.
INTERVAL_15_MIN Agrégez les journaux par intervalles de 15 minutes.

Métadonnées

Configure les champs de journaux à inclure.

Énumérations
METADATA_UNSPECIFIED Si aucune valeur n'est spécifiée, la valeur par défaut est INCLUDE_ALL_METADATA.
INCLUDE_ALL_METADATA Incluez tous les champs de métadonnées.
EXCLUDE_ALL_METADATA Excluez tous les champs de métadonnées.
CUSTOM_METADATA Incluez uniquement les champs personnalisés (spécifiés dans metadataFields).

CrossProjectMetadata

Détermine s'il faut inclure les annotations inter-projets dans les journaux. Les configurations de projet auront toujours CROSS_PROJECT_METADATA_DISABLED.

Énumérations
CROSS_PROJECT_METADATA_UNSPECIFIED Si aucune valeur n'est spécifiée, la valeur par défaut est CROSS_PROJECT_METADATA_ENABLED.
CROSS_PROJECT_METADATA_ENABLED Lorsque CROSS_PROJECT_METADATA_ENABLED est défini sur "true", les métadonnées d'autres projets sont incluses dans les journaux.
CROSS_PROJECT_METADATA_DISABLED Lorsque CROSS_PROJECT_METADATA_DISABLED est défini, les métadonnées des autres projets ne sont pas incluses dans les journaux.

TargetResourceState

Uniquement en sortie. Indique si la ressource cible existe, à des fins de diagnostic.

Énumérations
TARGET_RESOURCE_STATE_UNSPECIFIED État de la ressource cible non spécifié.
TARGET_RESOURCE_EXISTS Indique que la ressource cible existe.
TARGET_RESOURCE_DOES_NOT_EXIST Indique que la ressource cible n'existe pas.

Méthodes

create

 Crée un objet VpcFlowLogsConfig.

delete

 Supprime un VpcFlowLogsConfig spécifique.

get

 Récupère les détails d'un VpcFlowLogsConfig spécifique.

list

 Répertorie tous les VpcFlowLogsConfigs d'une organisation donnée.

patch

 Met à jour une valeur VpcFlowLogsConfig existante.