REST Resource: organizations.locations.vpcFlowLogsConfigs

Recurso: VpcFlowLogsConfig

Uma configuração para gerar registros de fluxo da VPC.

Representação 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. Nome exclusivo da configuração. O nome pode ter uma das seguintes formas:

  • Para configurações no nível do projeto: projects/{projectId}/locations/global/vpcFlowLogsConfigs/{vpcFlowLogsConfigId}

  • Para configurações no nível da organização: organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpcFlowLogsConfigId}
metadataFields[]

string

Opcional. Campos de metadados personalizados a serem incluídos nos registros de fluxo de VPC informados. Só poderá ser especificado se "metadata" estiver definido como CUSTOM_METADATA.
labels

map (key: string, value: string)

Opcional. Rótulos de recursos para representar metadados fornecidos por usuários

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Apenas saída. O horário em que a configuração foi criada.

Usa RFC 3339, em que a saída gerada é sempre normalizada em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Outros ajustes também são aceitos. Por exemplo, "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30";
updateTime

string (Timestamp format)

Apenas saída. A hora em que a configuração foi atualizada.

Usa RFC 3339, em que a saída gerada é sempre normalizada em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Outros ajustes também são aceitos. Por exemplo, "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30";
description

string

Opcional. A descrição fornecida pelo usuário da configuração dos Registros de fluxo de VPC. Use no máximo 512 caracteres.
state

enum (State)

Opcional. O estado da configuração de registros de fluxo de VPC. O valor padrão é ENABLED. Ao criar uma configuração, ela precisa ser ativada. Definir state=DISABLED vai pausar a geração de registros para essa configuração.
aggregationInterval

enum (AggregationInterval)

Opcional. O intervalo de agregação dos registros. O valor padrão é INTERVAL_5_SEC.
flowSampling

number

Opcional. O valor do campo precisa estar entre (0, 1]. A taxa de amostragem dos registros de fluxo de VPC, em que 1,0 significa que todos os registros coletados são reportados. Não é permitido definir a taxa de amostragem como 0,0. Se você quiser desativar os registros de fluxo da VPC, use o campo "state". O valor padrão é 1,0.
metadata

enum (Metadata)

Opcional. Configura se todos, nenhum ou um subconjunto de campos de metadados precisam ser adicionados aos registros de fluxo de VPC reportados. O valor padrão é INCLUDE_ALL_METADATA.
filterExpr

string

Opcional. Filtro de exportação usado para definir quais registros de fluxo de VPC precisam ser registrados.
crossProjectMetadata

enum (CrossProjectMetadata)

Opcional. Determina se as anotações entre projetos serão incluídas nos registros. Esse campo está disponível apenas para configurações da organização. Se não for especificado nas configurações da organização, será definido como CROSS_PROJECT_METADATA_ENABLED.
targetResourceState

enum (TargetResourceState)

Apenas saída. Descreve o estado do recurso de destino configurado para fins de diagnóstico.
Campo de união target_resource. Referência ao recurso do escopo de configuração. Ou seja, o escopo de onde o tráfego é registrado. O recurso de destino precisa pertencer ao mesmo projeto que a configuração. Esse campo não é compatível com configurações no nível da organização. target_resource pode ser apenas de um dos tipos a seguir:
network

string

O tráfego será registrado de VMs, túneis de VPN e anexos do Interconnect na rede. Formato: projects/{projectId}/global/networks/{name}
subnet

string

O tráfego será registrado das VMs na sub-rede. Formato: projects/{projectId}/regions/{region}/subnetworks/{name}
interconnectAttachment

string

O tráfego será registrado no anexo de interconexão. Formato: projects/{projectId}/regions/{region}/interconnectAttachments/{name}
vpnTunnel

string

O tráfego será registrado no túnel da VPN. Formato: projects/{projectId}/regions/{region}/vpnTunnels/{name}

Estado

Determina se essa configuração vai gerar registros.

Enums
STATE_UNSPECIFIED Se não for especificado, o padrão será "ENABLED".
ENABLED Quando ENABLED, essa configuração gera registros.
DISABLED Quando DISABLED, essa configuração não gera registros.

AggregationInterval

Alterna o intervalo de agregação para coletar registros de fluxo por 5 tuplas.

Enums
AGGREGATION_INTERVAL_UNSPECIFIED Se não for especificado, o padrão será INTERVAL_5_SEC.
INTERVAL_5_SEC Agregue registros em intervalos de 5 segundos.
INTERVAL_30_SEC Agregue registros em intervalos de 30 segundos.
INTERVAL_1_MIN Agregue registros em intervalos de 1 minuto.
INTERVAL_5_MIN Agregue registros em intervalos de 5 minutos.
INTERVAL_10_MIN Agregue registros em intervalos de 10 minutos.
INTERVAL_15_MIN Agregue registros em intervalos de 15 minutos.

Metadados

Configura quais campos de registro serão incluídos.

Enums
METADATA_UNSPECIFIED Se não for especificado, o padrão será INCLUDE_ALL_METADATA.
INCLUDE_ALL_METADATA Inclua todos os campos de metadados.
EXCLUDE_ALL_METADATA Exclua todos os campos de metadados.
CUSTOM_METADATA Inclua apenas campos personalizados (especificados em metadataFields).

CrossProjectMetadata

Determina se as anotações entre projetos serão incluídas nos registros. As configurações de projeto sempre terão CROSS_PROJECT_METADATA_DISABLED.

Enums
CROSS_PROJECT_METADATA_UNSPECIFIED Se não for especificado, o padrão será CROSS_PROJECT_METADATA_ENABLED.
CROSS_PROJECT_METADATA_ENABLED Quando CROSS_PROJECT_METADATA_ENABLED, os metadados de outros projetos são incluídos nos registros.
CROSS_PROJECT_METADATA_DISABLED Quando CROSS_PROJECT_METADATA_DISABLED, os metadados de outros projetos não são incluídos nos registros.

TargetResourceState

Apenas saída. Indica se o recurso de destino existe, para fins de diagnóstico.

Enums
TARGET_RESOURCE_STATE_UNSPECIFIED Estado do recurso de destino não especificado.
TARGET_RESOURCE_EXISTS Indica que o recurso de destino existe.
TARGET_RESOURCE_DOES_NOT_EXIST Indica que o recurso de destino não existe.

Métodos

create

 Cria um VpcFlowLogsConfig novo.

delete

 Exclui um VpcFlowLogsConfig específico.

get

 Recebe os detalhes de um VpcFlowLogsConfig específico.

list

 Lista todos os VpcFlowLogsConfigs em uma determinada organização.

patch

 Atualiza um VpcFlowLogsConfig existente.