Method: projects.locations.vpcFlowLogsConfigs.showEffectiveFlowLogsConfigs

O vpcFlowLogsConfigs.showEffectiveFlowLogsConfigs retorna uma lista de todas as configurações de registros de fluxo de VPC aplicáveis a um recurso especificado.

Solicitação HTTP

GET https://networkmanagement.googleapis.com/v1/{parent=projects/*/locations/*}/vpcFlowLogsConfigs:showEffectiveFlowLogsConfigs

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O recurso pai do VpcFlowLogsConfig, especificado no seguinte formato: projects/{projectId}/locations/global

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • networkmanagement.vpcflowlogsconfigs.list

Parâmetros de consulta

Parâmetros
resource

string

Obrigatório. O recurso que deve receber a configuração efetiva dos registros de fluxo de VPC. Ele precisa pertencer ao mesmo projeto que o pai e ser uma rede, uma sub-rede, um anexo de interconexão, um túnel de VPN ou um projeto.
pageSize

integer

Opcional. Número de EffectiveVpcFlowLogsConfigs que deve ser retornado. O padrão é 30.
pageToken

string

Opcional. Token de página de uma consulta anterior, conforme retornado em nextPageToken.
filter

string

Opcional. Lista o EffectiveVpcFlowLogsConfigs que corresponde à expressão de filtro. Uma expressão de filtro precisa usar os operadores lógicos da CEL compatíveis.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Resposta para o método vpcFlowLogsConfigs.showEffectiveFlowLogsConfigs.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "effectiveFlowLogsConfigs": [
    {
      object (EffectiveVpcFlowLogsConfig)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Campos
effectiveFlowLogsConfigs[]

object (EffectiveVpcFlowLogsConfig)

Lista de configurações efetivas de registros de fluxo de VPC.
nextPageToken

string

Token de página para buscar o próximo conjunto de configurações.
unreachable[]

string

Locais que não puderam ser alcançados (quando consultados com -).

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para mais informações, consulte Authentication Overview.

EffectiveVpcFlowLogsConfig

Uma configuração para gerar uma resposta à solicitação GetEffectiveVpcFlowLogsConfig.

Representação JSON 
{
  "name": string,
  "metadataFields": [
    string
  ],
  "state": enum (State),
  "aggregationInterval": enum (AggregationInterval),
  "flowSampling": number,
  "metadata": enum (Metadata),
  "filterExpr": string,
  "crossProjectMetadata": enum (CrossProjectMetadata),

  // 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.
  "scope": enum (Scope)
}
Campos
name

string

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}

  • Para uma configuração do Compute, o nome será o caminho da sub-rede: projects/{projectId}/regions/{region}/subnetworks/{subnet_id}
metadataFields[]

string

Campos de metadados personalizados que devem ser incluídos nos registros de fluxos de VPC informados. Só pode ser especificado se "metadata" estiver definido como CUSTOM_METADATA.
state

enum (State)

O estado da configuração dos registros de fluxos da 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)

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

number

O valor do campo precisa ficar 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 fluxos de VPC, use o campo "Estado". O valor padrão é 1,0.
metadata

enum (Metadata)

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

string

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

enum (CrossProjectMetadata)

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.
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 de interconexão da rede. Formato: projects/{projectId}/global/networks/{name}
subnet

string

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

string

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

string

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

enum (Scope)

Especifica o escopo da configuração (por exemplo, SUBNET, NETWORK, ORGANIZATION etc.).

Escopo

O escopo dessa configuração de registro de fluxo.

Tipos enumerados
SCOPE_UNSPECIFIED O escopo não foi especificado.
SUBNET O recurso de destino é uma sub-rede (API Network Management).
COMPUTE_API_SUBNET O recurso de destino é uma sub-rede, e a configuração tem como origem a API Compute.
NETWORK O recurso de destino é uma rede.
VPN_TUNNEL O recurso de destino é um túnel de VPN.
INTERCONNECT_ATTACHMENT O recurso de destino é um anexo de interconexão.
ORGANIZATION A configuração se aplica a toda a organização.