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,
  "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}

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

Liste tous les VpcFlowLogsConfigs d'un projet donné.

patch

Met à jour une valeur VpcFlowLogsConfig existante.

queryOrgVpcFlowLogsConfigs

QueryOrgVpcFlowLogsConfigs renvoie la liste de toutes les configurations de journaux de flux VPC au niveau de l'organisation applicables au projet spécifié.