Method: projects.locations.vpcFlowLogsConfigs.showEffectiveFlowLogsConfigs

vpcFlowLogsConfigs.showEffectiveFlowLogsConfigs devolve uma lista de todas as configurações dos registos de fluxo da VPC aplicáveis a um recurso especificado.

Pedido HTTP

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

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

Parâmetros de caminho

Parâmetros
parent

string

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

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

  • networkmanagement.vpcflowlogsconfigs.list

Parâmetros de consulta

Parâmetros
resource

string

Obrigatório. O recurso para o qual obter a configuração eficaz dos registos de fluxo da VPC. O recurso tem de pertencer ao mesmo projeto que o recurso principal. O recurso tem de ser uma rede, uma sub-rede, uma ligação de interconexão, um túnel de VPN ou um projeto.

pageSize

integer

Opcional. Número de EffectiveVpcFlowLogsConfigs a devolver. A predefinição é 30.

pageToken

string

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

filter

string

Opcional. Apresenta as EffectiveVpcFlowLogsConfigs que correspondem à expressão de filtro. Uma expressão de filtro tem de usar os operadores lógicos do IEC suportados.

Corpo do pedido

O corpo do pedido tem de estar vazio.

Corpo da resposta

Resposta para o método vpcFlowLogsConfigs.showEffectiveFlowLogsConfigs.

Se for bem-sucedido, o corpo da resposta contém dados com a seguinte estrutura:

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

object (EffectiveVpcFlowLogsConfig)

Lista de configurações de registos de fluxo de VPC eficazes.

nextPageToken

string

Token da página para obter o conjunto seguinte de configurações.

unreachable[]

string

Localizações que não foram alcançadas (quando consulta todas as localizações com -).

Âmbitos de autorização

Requer o seguinte âmbito do OAuth:

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

Para mais informações, consulte o Authentication Overview.

EffectiveVpcFlowLogsConfig

Uma configuração para gerar uma resposta para o pedido 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 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}

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

metadataFields[]

string

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.

state

enum (State)

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)

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

flowSampling

number

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)

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

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

crossProjectMetadata

enum (CrossProjectMetadata)

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.

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}

scope

enum (Scope)

Especifica o âmbito da configuração (por exemplo, SUBNET, NETWORK, ORGANIZATION…).

Âmbito

O âmbito desta configuração de registo de fluxo.

Enumerações
SCOPE_UNSPECIFIED O âmbito não está 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 origem na 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 é uma associação de interligação.
ORGANIZATION A configuração aplica-se a toda uma organização.