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

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

string

Identifiant. Nom unique de la configuration au format suivant: projects/{projectId}/locations/global/vpcFlowLogsConfigs/{vpcFlowLogsConfigId}

metadataFields[]

string

Facultatif. Champs de métadonnées personnalisées à 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.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Uniquement en sortie. Heure de mise à jour de la configuration.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

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, elle doit être activée.

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, 1]). Taux d'échantillonnage des journaux de flux VPC, où 1,0 signifie que tous les journaux collectés sont signalés. Il n'est pas possible 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. Permet de configurer si tous les champs de métadonnées, aucun ou un sous-ensemble de champs de métadonnées 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 à consigner.

Champ d'union target_resource. Référence à la ressource du champ d'application de la configuration. c'est-à-dire le champ d'application à partir duquel le trafic est consigné. La ressource cible doit appartenir au même projet que la configuration. target_resource ne peut être qu'un des éléments suivants :
interconnectAttachment

string

Le trafic sera journalisé à partir du rattachement d'interconnexion. 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 va générer des journaux. Définir state=DISABLED suspend la génération de journaux pour cette configuration.

Enums
STATE_UNSPECIFIED Si aucune valeur n'est spécifiée, la valeur par défaut est ACTIVÉE.
ENABLED Lorsque cette option est ACTIVÉE, cette configuration génère des journaux.
DISABLED Lorsque cette option est désactivée, cette configuration ne génère pas de journaux.

AggregationInterval

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

Enums
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 5 s.
INTERVAL_30_SEC Agrégez les journaux par intervalles de 30 secondes.
INTERVAL_1_MIN Agrégez les journaux par intervalles d'un mois.
INTERVAL_5_MIN Agrégez les journaux par intervalles de cinq minutes.
INTERVAL_10_MIN Agrégation des journaux à intervalles de 10 min.
INTERVAL_15_MIN Agrégez les journaux par intervalles de 15 minutes.

Métadonnées

Configure les champs de journal à inclure.

Enums
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 N'incluez que des champs personnalisés (spécifiés dans metadataFields).

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'un projet donné.

patch

Met à jour un élément VpcFlowLogsConfig existant.