REST Resource: projects.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,

  // Union field target_resource can be only one of the following:
  "interconnectAttachment": string,
  "vpnTunnel": string
  // End of list of possible types for union field target_resource.
}
Campos
name

string

Identificador. Es el nombre único de la configuración con el formato: projects/{projectId}/locations/global/vpcFlowLogsConfigs/{vpcFlowLogsConfigId}

metadataFields[]

string

Opcional. Son campos de metadatos personalizados que se incluyen 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 hora en la que se creó la configuración.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Solo salida. La hora en la que se actualizó la configuración.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

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, esta debe estar habilitada.

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 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 agregar todos, ninguno o un subconjunto de 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.

Campo de unión target_resource. Es la referencia al recurso del permiso de 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. target_resource puede ser solo uno de los siguientes:
interconnectAttachment

string

El tráfico se registrará desde el archivo adjunto de Interconnect. Formato: projects/{projectId}/regions/{region}/interconnectAttachments/{name}

vpnTunnel

string

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

Estado

Determina si esta configuración generará registros. Si estableces state=DISABLED, se detendrá la generación de registros para esta configuración.

Enums
STATE_UNSPECIFIED Si no se especifica, se establecerá de forma predeterminada en ENABLED.
ENABLED Cuando esté ENABLED, esta configuración generará registros.
DISABLED Si está DISABLED, esta configuración no generará registros.

AggregationInterval

Activa o desactiva el intervalo de agregación para recopilar registros de flujo por 5 tuplas.

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

Metadatos

Configura qué campos de registro se incluirán.

Enums
METADATA_UNSPECIFIED Si no se especifica, el valor predeterminado será INCLUDE_ALL_METADATA.
INCLUDE_ALL_METADATA Incluye todos los campos de metadatos.
EXCLUDE_ALL_METADATA Excluye todos los campos de metadatos.
CUSTOM_METADATA Incluye solo campos personalizados (especificados en metadataFields).

Métodos

create

Crea una VpcFlowLogsConfig nueva.

delete

Elimina una VpcFlowLogsConfig específica.

get

Obtiene los detalles de un VpcFlowLogsConfig específico.

list

Muestra una lista de todos los VpcFlowLogsConfigs de un proyecto determinado.

patch

Actualiza un VpcFlowLogsConfig existente.