REST Resource: organizations.locations.vpcFlowLogsConfigs

Recurso: VpcFlowLogsConfig

Uma configuração para gerar registos 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 ao nível do projeto: projects/{projectId}/locations/global/vpcFlowLogsConfigs/{vpcFlowLogsConfigId}

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

string

Opcional. Campos de metadados personalizados a incluir nos registos de fluxo de VPC comunicados. Só pode ser especificado se "metadata" tiver sido definido como CUSTOM_METADATA.
labels

map (key: string, value: string)

Opcional. Etiquetas de recursos para representar metadados fornecidos pelos utilizadores.

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

string (Timestamp format)

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

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "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 o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "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 utilizador da configuração dos registos de fluxo da VPC. Um máximo de 512 carateres.
state

enum (State)

Opcional. O estado da configuração do VPC Flow Logs. O valor predefinido é ENABLED. Quando cria uma nova configuração, esta tem de ser ativada. A definição state=DISABLED pausa a geração de registos para esta configuração.
aggregationInterval

enum (AggregationInterval)

Opcional. O intervalo de agregação para os registos. O valor predefinido é INTERVAL_5_SEC.
flowSampling

number

Opcional. O valor do campo tem de estar em (0, 1]. A taxa de amostragem dos registos de fluxo de VPC, em que 1,0 significa que todos os registos recolhidos são comunicados. Não é permitido definir a taxa de amostragem como 0,0. Se quiser desativar os registos de fluxo de VPC, use o campo de estado. O valor predefinido é 1,0.
metadata

enum (Metadata)

Opcional. Configura se todos, nenhum ou um subconjunto de campos de metadados devem ser adicionados aos registos de fluxo de VPC comunicados. O valor predefinido é INCLUDE_ALL_METADATA.
filterExpr

string

Opcional. Filtro de exportação usado para definir que VPC Flow Logs devem ser registados.
crossProjectMetadata

enum (CrossProjectMetadata)

Opcional. Determina se devem ser incluídas anotações entre projetos nos registos. Este campo só está disponível para configurações de organização. Se não for especificado nas configurações da organização, é 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 âmbito de configuração. Ou seja, o âmbito a partir do qual o tráfego é registado. O recurso de destino tem de pertencer ao mesmo projeto que a configuração. Este campo não é suportado para configurações ao nível da organização. target_resource só pode ser uma das seguintes opções:
network

string

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

string

O tráfego é registado a partir de VMs na sub-rede. Formato: projects/{projectId}/regions/{region}/subnetworks/{name}
interconnectAttachment

string

O tráfego é registado a partir da associação do Interconnect. Formato: projects/{projectId}/regions/{region}/interconnectAttachments/{name}
vpnTunnel

string

O tráfego é registado a partir do túnel VPN. Formato: projects/{projectId}/regions/{region}/vpnTunnels/{name}

Estado

Determina se esta configuração vai gerar registos.

Enumerações
STATE_UNSPECIFIED Se não for especificado, o valor predefinido é ENABLED.
ENABLED Quando está ATIVADA, esta configuração gera registos.
DISABLED Quando está DESATIVADA, esta configuração não gera registos.

AggregationInterval

Ativa/desativa o intervalo de agregação para recolher registos de fluxo por 5 tuplos.

Enumerações
AGGREGATION_INTERVAL_UNSPECIFIED Se não for especificado, a predefinição é INTERVAL_5_SEC.
INTERVAL_5_SEC Agregue registos em intervalos de 5 segundos.
INTERVAL_30_SEC Agregue registos em intervalos de 30 segundos.
INTERVAL_1_MIN Agregue registos em intervalos de 1 minuto.
INTERVAL_5_MIN Agregue registos em intervalos de 5 minutos.
INTERVAL_10_MIN Agregue registos em intervalos de 10 minutos.
INTERVAL_15_MIN Agregue registos em intervalos de 15 minutos.

Metadados

Configura os campos de registo que seriam incluídos.

Enumerações
METADATA_UNSPECIFIED Se não for especificado, a predefinição é 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 devem ser incluídas anotações entre projetos nos registos. As configurações do projeto têm sempre CROSS_PROJECT_METADATA_DISABLED.

Enumerações
CROSS_PROJECT_METADATA_UNSPECIFIED Se não for especificado, o valor predefinido é CROSS_PROJECT_METADATA_ENABLED.
CROSS_PROJECT_METADATA_ENABLED Quando CROSS_PROJECT_METADATA_ENABLED, os metadados de outros projetos são incluídos nos registos.
CROSS_PROJECT_METADATA_DISABLED Quando CROSS_PROJECT_METADATA_DISABLED, os metadados de outros projetos não são incluídos nos registos.

TargetResourceState

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

Enumerações
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 novo VpcFlowLogsConfig.

delete

 Elimina um VpcFlowLogsConfig específico.

get

 Obtém os detalhes de um VpcFlowLogsConfig específico.

list

 Lista todos os VpcFlowLogsConfigs numa determinada organização.

patch

 Atualiza um VpcFlowLogsConfig existente.