Method: projects.locations.vpcFlowLogsConfigs.showEffectiveFlowLogsConfigs

vpcFlowLogsConfigs.showEffectiveFlowLogsConfigs renvoie la liste de toutes les configurations de journaux de flux VPC applicables à une ressource spécifiée.

Requête HTTP

GET https://networkmanagement.googleapis.com/v1/{parent=projects/*/locations/*}/vpcFlowLogsConfigs:showEffectiveFlowLogsConfigs

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Ressource parente de VpcFlowLogsConfig, spécifiée au format suivant : projects/{projectId}/locations/global

L'autorisation IAM suivante est requise pour la ressource parent indiquée :

  • networkmanagement.vpcflowlogsconfigs.list

Paramètres de requête

Paramètres
resource

string

Obligatoire. Ressource pour laquelle obtenir la configuration effective des journaux de flux VPC. La ressource doit appartenir au même projet que le parent. La ressource doit être un réseau, un sous-réseau, un rattachement d'interconnexion, un tunnel VPN ou un projet.
pageSize

integer

Facultatif. Nombre de EffectiveVpcFlowLogsConfigs à renvoyer. La valeur par défaut est 30.
pageToken

string

Facultatif. Jeton de page d'une requête antérieure, tel que renvoyé dans nextPageToken.
filter

string

Facultatif. Répertorie les EffectiveVpcFlowLogsConfigs qui correspondent à l'expression de filtre. Une expression de filtre doit utiliser les opérateurs logiques CEL compatibles.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Réponse pour la méthode vpcFlowLogsConfigs.showEffectiveFlowLogsConfigs.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "effectiveFlowLogsConfigs": [
    {
      object (EffectiveVpcFlowLogsConfig)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Champs
effectiveFlowLogsConfigs[]

object (EffectiveVpcFlowLogsConfig)

Liste des configurations de journaux de flux VPC effectives.
nextPageToken

string

Jeton de page pour récupérer la prochaine série de configurations.
unreachable[]

string

Emplacements qui n'ont pas pu être atteints (lors de l'interrogation de tous les emplacements avec l'opérateur -).

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour plus d'informations, consultez la Authentication Overview.

EffectiveVpcFlowLogsConfig

Configuration permettant de générer une réponse pour la requête GetEffectiveVpcFlowLogsConfig.

Représentation JSON 
{
  "name": string,
  "metadataFields": [
    string
  ],
  "state": enum (State),
  "aggregationInterval": enum (AggregationInterval),
  "flowSampling": number,
  "metadata": enum (Metadata),
  "filterExpr": string,
  "crossProjectMetadata": enum (CrossProjectMetadata),

  // 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.
  "scope": enum (Scope)
}
Champs
name

string

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}

  • Pour une configuration Compute, le nom correspond au chemin d'accès du sous-réseau : projects/{projectId}/regions/{region}/subnetworks/{subnet_id}
metadataFields[]

string

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

enum (State)

É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)

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

number

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)

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

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

enum (CrossProjectMetadata)

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.
Champ d'union target_resource. Référence à la ressource du champ de 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}
scope

enum (Scope)

Spécifie le champ d'application de la configuration (par exemple, SUBNET, NETWORK, ORGANIZATION..).

Champ d'application

Champ d'application de cette configuration de journaux de flux.

Enums
SCOPE_UNSPECIFIED Le champ d'application n'est pas spécifié.
SUBNET La ressource cible est un sous-réseau (API Network Management).
COMPUTE_API_SUBNET La ressource cible est un sous-réseau et la configuration provient de l'API Compute.
NETWORK La ressource cible est un réseau.
VPN_TUNNEL La ressource cible est un tunnel VPN.
INTERCONNECT_ATTACHMENT La ressource cible est un rattachement Interconnect.
ORGANIZATION La configuration s'applique à l'ensemble d'une organisation.