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

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

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

createTime

string (Timestamp format)

Es solo 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 salida. Es la fecha y hora en 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 para 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 el 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 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 puede ser solo 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}

Métodos

create

Cree una VpcFlowLogsConfig nueva.

delete

Borra una VpcFlowLogsConfig específica.

get

Obtiene los detalles de una VpcFlowLogsConfig específica.

list

Enumera todas las VpcFlowLogsConfigs de un proyecto determinado.

patch

Actualiza una 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 organización que se aplican al proyecto especificado.

showEffectiveFlowLogsConfigs

ShowEffectiveFlowLogsConfigs devuelve una lista de todos los parámetros de configuración de los registros de flujo de VPC aplicables a un recurso especificado.