REST Resource: projects.locations.vpcFlowLogsConfigs

Recurso: VpcFlowLogsConfig

Es una configuración para generar registros de flujo de VPC.

Representación 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.
}
Campos
name

string

Identificador. Nombre único de la configuración. El nombre puede tener una de las siguientes formas:

  • Para la configuración a nivel del proyecto: projects/{projectId}/locations/global/vpcFlowLogsConfigs/{vpcFlowLogsConfigId}

  • Para los parámetros de configuración a nivel de la organización: organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpcFlowLogsConfigId}
metadataFields[]

string

Opcional. Son los campos de metadatos personalizados que se incluirán en los registros de flujo de VPC informados. Solo se puede especificar si "metadata" se estableció en CUSTOM_METADATA.
labels

map (key: string, value: string)

Opcional. Son las etiquetas de los recursos para representar los metadatos proporcionados por el usuario.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Solo salida. Es la fecha y hora en que se creó la configuración.

Usa el RFC 3339, en el que el resultado generado siempre se normaliza según la zona horaria Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Solo salida. Es la fecha y hora en que se actualizó la configuración.

Usa el RFC 3339, en el que el resultado generado siempre se normaliza según la zona horaria Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
description

string

Opcional. Es la descripción proporcionada por el usuario de la configuración de los registros de flujo de VPC. Puede tener un máximo de 512 caracteres
state

enum (State)

Opcional. Es el estado de la configuración de los registros de flujo de VPC. El valor predeterminado es ENABLED. Cuando crees una configuración nueva, debes habilitarla. Si se establece state=DISABLED, se pausará la generación de registros para esta configuración.
aggregationInterval

enum (AggregationInterval)

Opcional. Es el intervalo de agregación de los registros. El valor predeterminado es INTERVAL_5_SEC.
flowSampling

number

Opcional. El valor del campo debe estar en (0, 1]. Es la tasa de muestreo de los registros de flujo de VPC, donde 1.0 significa que se informan todos los registros recopilados. No se permite establecer la tasa de muestreo en 0.0. Si deseas inhabilitar los registros de flujo de VPC, usa el campo de estado. El valor predeterminado es 1.0.
metadata

enum (Metadata)

Opcional. Configura si se deben agregar todos, ninguno o un subconjunto de los campos de metadatos a los registros de flujo de VPC informados. El valor predeterminado es INCLUDE_ALL_METADATA.
filterExpr

string

Opcional. Es el filtro de exportación que se usa para definir qué registros de flujo de VPC se deben registrar.
crossProjectMetadata

enum (CrossProjectMetadata)

Opcional. Determina si se deben incluir anotaciones entre proyectos en los registros. Este campo solo está disponible para las configuraciones de la organización. Si no se especifica en la configuración de la organización, se establecerá en CROSS_PROJECT_METADATA_ENABLED.
targetResourceState

enum (TargetResourceState)

Solo salida. Describe el estado del recurso de destino configurado para fines de diagnóstico.
Campo de unión target_resource. Es la referencia al recurso del alcance de la configuración. Es decir, el alcance desde el que se registra el tráfico. El recurso de destino debe pertenecer al mismo proyecto que la configuración. Este campo no es compatible con las configuraciones a nivel de la organización. target_resource puede ser solo uno de los siguientes:
network

string

Se registrará el tráfico de las VMs, los túneles VPN y los adjuntos de interconexión dentro de la red. Formato: projects/{projectId}/global/networks/{name}
subnet

string

Se registrará el tráfico de las VMs dentro de la subred. Formato: projects/{projectId}/regions/{region}/subnetworks/{name}
interconnectAttachment

string

El tráfico se registrará desde la conexión de Interconnect. Formato: projects/{projectId}/regions/{region}/interconnectAttachments/{name}
vpnTunnel

string

Se registrará el tráfico del túnel VPN. Formato: projects/{projectId}/regions/{region}/vpnTunnels/{name}

Métodos

create

 Crea una VpcFlowLogsConfig nueva.

delete

 Elimina una VpcFlowLogsConfig específica.

get

 Obtiene los detalles de un VpcFlowLogsConfig específico.

list

 Enumera todos los VpcFlowLogsConfigs en un proyecto determinado.

patch

 Actualiza un VpcFlowLogsConfig existente.

queryOrgVpcFlowLogsConfigs

 QueryOrgVpcFlowLogsConfigs devuelve una lista de todos los parámetros de configuración de los registros de flujo de VPC a nivel de la organización que se aplican al proyecto especificado.