REST Resource: organizations.locations.vpcFlowLogsConfigs

Recurso: VpcFlowLogsConfig

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 uno de los siguientes formatos:

  • Para las configuraciones a nivel de proyecto, consulta projects/{projectId}/locations/global/vpcFlowLogsConfigs/{vpcFlowLogsConfigId}.

  • Para las configuraciones a nivel de organización: organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpcFlowLogsConfigId}
metadataFields[]

string

Opcional. Campos de metadatos personalizados que se incluirán en los registros de flujo de VPC notificados. Solo se puede especificar si "metadata" se ha definido como CUSTOM_METADATA.
labels

map (key: string, value: string)

Opcional. Etiquetas de recursos para representar 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 de salida. Hora en la que se creó la configuración.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "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 de salida. Hora en la que se actualizó la configuración.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
description

string

Opcional. Descripción proporcionada por el usuario de la configuración de los registros de flujo de VPC. Puede tener una longitud máxima de 512 caracteres.
state

enum (State)

Opcional. Estado de la configuración de Registros de flujo de VPC. El valor predeterminado es ENABLED. Cuando cree una configuración, debe habilitarla. Si se define el valor state=DISABLED, se pausará la generación de registros de esta configuración.
aggregationInterval

enum (AggregationInterval)

Opcional. Intervalo de agregación de los registros. El valor predeterminado es INTERVAL_5_SEC.
flowSampling

number

Opcional. El valor del campo debe ser una cifra entre 0 y 1 (1 incluido). Porcentaje de muestreo de los registros de flujo de VPC. El valor 1.0 significa que se registran todos los registros recogidos. No se puede definir la frecuencia de muestreo en 0,0. Si quieres 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 añadir todos, ninguno o un subconjunto de los campos de metadatos a los registros de flujo de VPC registrados. El valor predeterminado es INCLUDE_ALL_METADATA.
filterExpr

string

Opcional. 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 organizaciones. Si no se especifica en las configuraciones de la organización, se asignará el valor CROSS_PROJECT_METADATA_ENABLED.
targetResourceState

enum (TargetResourceState)

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

string

El tráfico se registrará desde las máquinas virtuales, los túneles VPN y los adjuntos de Interconnect de la red. Formato: projects/{projectId}/global/networks/{name}
subnet

string

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

string

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

string

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

Estado

Determina si esta configuración generará registros.

Enumeraciones
STATE_UNSPECIFIED Si no se especifica, se utilizará el valor ENABLED de forma predeterminada.
ENABLED Si se habilita, esta configuración generará registros.
DISABLED Si se inhabilita, esta configuración no generará registros.

AggregationInterval

Activa o desactiva el intervalo de agregación para recoger registros de flujo por tupla de 5 elementos.

Enumeraciones
AGGREGATION_INTERVAL_UNSPECIFIED Si no se especifica, se usará INTERVAL_5_SEC de forma predeterminada.
INTERVAL_5_SEC Agrega los registros en intervalos de 5 segundos.
INTERVAL_30_SEC Agrega los registros en intervalos de 30 segundos.
INTERVAL_1_MIN Agrega los registros en intervalos de 1 minuto.
INTERVAL_5_MIN Agrega los registros en intervalos de 5 minutos.
INTERVAL_10_MIN Agrega los registros en intervalos de 10 minutos.
INTERVAL_15_MIN Agrega los registros en intervalos de 15 minutos.

Metadatos

Configura los campos de registro que se incluirán.

Enumeraciones
METADATA_UNSPECIFIED Si no se especifica, se usará INCLUDE_ALL_METADATA de forma predeterminada.
INCLUDE_ALL_METADATA Incluye todos los campos de metadatos.
EXCLUDE_ALL_METADATA Excluye todos los campos de metadatos.
CUSTOM_METADATA Incluye solo los campos personalizados (especificados en metadataFields).

CrossProjectMetadata

Determina si se deben incluir anotaciones entre proyectos en los registros. Las configuraciones de proyectos siempre tendrán el valor CROSS_PROJECT_METADATA_DISABLED.

Enumeraciones
CROSS_PROJECT_METADATA_UNSPECIFIED Si no se especifica, el valor predeterminado es CROSS_PROJECT_METADATA_ENABLED.
CROSS_PROJECT_METADATA_ENABLED Si CROSS_PROJECT_METADATA_ENABLED es true, los metadatos de otros proyectos se incluirán en los registros.
CROSS_PROJECT_METADATA_DISABLED Si CROSS_PROJECT_METADATA_DISABLED, los metadatos de otros proyectos no se incluirán en los registros.

TargetResourceState

Solo de salida. Indica si el recurso de destino existe con fines de diagnóstico.

Enumeraciones
TARGET_RESOURCE_STATE_UNSPECIFIED Estado del recurso de destino sin especificar.
TARGET_RESOURCE_EXISTS Indica que el recurso de destino existe.
TARGET_RESOURCE_DOES_NOT_EXIST Indica que el recurso de destino no existe.

Métodos

create

 Crea un VpcFlowLogsConfig.

delete

 Elimina un VpcFlowLogsConfig específico.

get

 Obtiene los detalles de un VpcFlowLogsConfig específico.

list

 Muestra todos los VpcFlowLogsConfigs de una organización determinada.

patch

 Actualiza un VpcFlowLogsConfig.