REST Resource: projects.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,
  "targetResourceState": enum (TargetResourceState),

  // 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. Nome exclusivo da configuração usando o formulário: projects/{projectId}/locations/global/vpcFlowLogsConfigs/{vpcFlowLogsConfigId}
metadataFields[]

string

Opcional. Campos de metadados personalizados para incluir nos registros de fluxo de VPC reportados. 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.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

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

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
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 do registro de fluxo de VPC. O valor padrão é ATIVADO. Ao criar uma nova configuração, ela precisa ser ativada.
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 de VPC, use o campo de estado. 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.
targetResourceState

enum (TargetResourceState)

Apenas saída. Um bit de diagnóstico: 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 em que o tráfego é registrado. O recurso de destino precisa pertencer ao mesmo projeto que a configuração. target_resource pode ser apenas de um dos tipos a seguir:
interconnectAttachment

string

O tráfego será registrado pelo anexo do Interconnect. Formato: projects/{projectId}/regions/{region}/interconnectAttachments/{name}
vpnTunnel

string

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

Estado

Determina se essa configuração vai gerar registros. A definição de state=DISABLED pausa a geração de registros para essa configuração.

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

AggregationInterval

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

Enums
AGGREGATION_INTERVAL_UNSPECIFIED Se não for especificado, o padrão será INTERVAL_5_SEC.
INTERVAL_5_SEC Agrupe os registros em intervalos de 5 segundos.
INTERVAL_30_SEC Agrupe os registros em intervalos de 30 segundos.
INTERVAL_1_MIN Agrupe registros em intervalos de 1 minuto.
INTERVAL_5_MIN Agrupe os registros em intervalos de 5 minutos.
INTERVAL_10_MIN Agrupe os registros em intervalos de 10 minutos.
INTERVAL_15_MIN Agrupe 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 Excluir todos os campos de metadados.
CUSTOM_METADATA Inclua apenas campos personalizados (especificados em metadataFields).

TargetResourceState

Estados opcionais do recurso de destino que são usados como parte do bit 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 um determinado projeto.

patch

 Atualiza um VpcFlowLogsConfig existente.