REST Resource: organizations.locations.vpcFlowLogsConfigs

Recurso: VpcFlowLogsConfig

Es una configuración que sirve 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

Es el identificador. Es el nombre único de la configuración. El nombre puede tener uno de los formatos que se indican a continuación:

  • Para parámetros de configuración a nivel de proyecto: projects/{projectId}/locations/global/vpcFlowLogsConfigs/{vpcFlowLogsConfigId}

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

string

Es opcional. Son los campos de metadatos personalizados que se incluirán en los registros de flujo de VPC que se informan. Solo se puede especificar si “Metadatos” se estableció en CUSTOM_METADATA.
labels

map (key: string, value: string)

Es opcional. Son las etiquetas de los recursos que sirven para representar los metadatos proporcionados por el usuario.

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

string (Timestamp format)

Es solo de salida. Indica la hora a la que se creó la operación.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. 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)

Es solo de salida. Es la hora a la que se actualizó la configuración.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. 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

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

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

enum (AggregationInterval)

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

number

Es opcional. El valor del campo debe ser de (0, 1]. Es la tasa de muestreo de los registros de flujo de VPC, en la que 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)

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

string

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

enum (CrossProjectMetadata)

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

enum (TargetResourceState)

Es solo de salida. Describe el estado del recurso de destino configurado para su diagnóstico.
Campo de unión target_resource. Es la referencia al recurso del permiso de la configuración. Es decir, el permiso 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 los parámetros de configuración a nivel de organización. target_resource solo puede ser uno de los parámetros 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 el adjunto de interconexión. Formato: projects/{projectId}/regions/{region}/interconnectAttachments/{name}
vpnTunnel

string

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

Estado

Determina si esta configuración generará registros.

Enums
STATE_UNSPECIFIED Si no se especifica, se usará HABILITADA de forma predeterminada.
ENABLED Cuando se establece en HABILITADA, esta configuración generará registros.
DISABLED Cuando se establece en INHABILITADA, esta configuración no generará registros.

AggregationInterval

Activa o desactiva el intervalo de agregación para recopilar registros de flujo según la quíntupla.

Enums
AGGREGATION_INTERVAL_UNSPECIFIED Si no se especifica, se usará INTERVAL_5_SEC de forma predeterminada.
INTERVAL_5_SEC Agrega registros en intervalos de 5 s.
INTERVAL_30_SEC Agrega registros en intervalos de 30 s.
INTERVAL_1_MIN Agrega registros en intervalos de 1 min.
INTERVAL_5_MIN Agrega registros en intervalos de 5 min.
INTERVAL_10_MIN Agrega registros en intervalos de 10 min.
INTERVAL_15_MIN Agrega registros en intervalos de 15 min.

Metadatos

Configura qué campos de registro se incluirán.

Enums
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. Los parámetros de configuración del proyecto siempre tendrán CROSS_PROJECT_METADATA_DISABLED.

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

TargetResourceState

Es solo de salida. Indica si existe el recurso de destino, con fines de diagnóstico.

Enums
TARGET_RESOURCE_STATE_UNSPECIFIED No se especificó el estado del recurso de destino.
TARGET_RESOURCE_EXISTS Indica que existe el recurso de destino.
TARGET_RESOURCE_DOES_NOT_EXIST Indica que el recurso de destino no existe.

Métodos

create

 Crea una VpcFlowLogsConfig nueva.

delete

 Borra una VpcFlowLogsConfig específica.

get

 Obtiene los detalles de una VpcFlowLogsConfig específica.

list

 Enumera todas las VpcFlowLogsConfigs de una organización determinada.

patch

 Actualiza una VpcFlowLogsConfig existente.