Method: projects.locations.vpcFlowLogsConfigs.showEffectiveFlowLogsConfigs

vpcFlowLogsConfigs.showEffectiveFlowLogsConfigs devuelve una lista de todas las configuraciones de registros de flujo de VPC aplicables a un recurso especificado.

Solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación a gRPC.

Parámetros de ruta

Parámetros
parent

string

Obligatorio. Recurso principal de VpcFlowLogsConfig, especificado en el siguiente formato: projects/{projectId}/locations/global

Para la autorización, se necesita el siguiente permiso de gestión de identidades y accesos en el recurso especificado parent:

  • networkmanagement.vpcflowlogsconfigs.list

Los parámetros de consulta

Parámetros
resource

string

Obligatorio. El recurso del que se va a obtener la configuración de registros de flujo de VPC en vigor. El recurso debe pertenecer al mismo proyecto que el elemento superior. El recurso debe ser una red, una subred, una vinculación de interconexión, un túnel VPN o un proyecto.
pageSize

integer

Opcional. Número de EffectiveVpcFlowLogsConfigs que se van a devolver. El valor predeterminado es 30.
pageToken

string

Opcional. Token de página de una consulta anterior, tal como se devuelve en nextPageToken.
filter

string

Opcional. Muestra una lista de los EffectiveVpcFlowLogsConfigs que coinciden con la expresión de filtro. Una expresión de filtro debe usar los operadores lógicos de CEL admitidos.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Respuesta del método vpcFlowLogsConfigs.showEffectiveFlowLogsConfigs.

Si la solicitud se realiza correctamente, el cuerpo de la respuesta proporciona datos con la siguiente estructura:

Representación JSON 
{
  "effectiveFlowLogsConfigs": [
    {
      object (EffectiveVpcFlowLogsConfig)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Campos
effectiveFlowLogsConfigs[]

object (EffectiveVpcFlowLogsConfig)

Lista de configuraciones de registros de flujo de VPCs efectivas.
nextPageToken

string

Token de página para obtener el siguiente conjunto de configuraciones.
unreachable[]

string

Ubicaciones a las que no se ha podido acceder (al consultar todas las ubicaciones con -).

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

Para obtener más información, consulta el Authentication Overview.

EffectiveVpcFlowLogsConfig

Configuración para generar una respuesta a una solicitud GetEffectiveVpcFlowLogsConfig.

Representación 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

Nombre único de la configuración. El nombre puede tener uno de los siguientes formatos:

  • Para las configuraciones a nivel de proyecto, consulta projects/{projectId}/locations/global/vpcFlowLogsConfigs/{vpcFlowLogsConfigId}.

  • Para las configuraciones a nivel de organización: organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpcFlowLogsConfigId}

  • En el caso de una configuración de Compute, el nombre será la ruta de la subred: projects/{projectId}/regions/{region}/subnetworks/{subnet_id}
metadataFields[]

string

Campos de metadatos personalizados que se incluirán en los registros de flujo de VPC notificados. Solo se puede especificar si "metadata" se ha definido como CUSTOM_METADATA.
state

enum (State)

Estado de la configuración de Registros de flujo de VPC. El valor predeterminado es ENABLED. Cuando cree una configuración, debe habilitarla. Si se define el valor state=DISABLED, se pausará la generación de registros de esta configuración.
aggregationInterval

enum (AggregationInterval)

Intervalo de agregación de los registros. El valor predeterminado es INTERVAL_5_SEC.
flowSampling

number

El valor del campo debe ser una cifra entre 0 y 1 (1 incluido). Porcentaje de muestreo de los registros de flujo de VPC. El valor 1.0 significa que se registran todos los registros recogidos. No se puede definir la frecuencia de muestreo en 0,0. Si quieres inhabilitar los registros de flujo de VPC, usa el campo de estado. El valor predeterminado es 1.0.
metadata

enum (Metadata)

Configura si se deben añadir todos, ninguno o un subconjunto de los campos de metadatos a los registros de flujo de VPC registrados. El valor predeterminado es INCLUDE_ALL_METADATA.
filterExpr

string

Filtro de exportación que se usa para definir qué registros de flujo de VPC se deben registrar.
crossProjectMetadata

enum (CrossProjectMetadata)

Determina si se deben incluir anotaciones entre proyectos en los registros. Este campo solo está disponible para las configuraciones de organizaciones. Si no se especifica en las configuraciones de la organización, se asignará el valor CROSS_PROJECT_METADATA_ENABLED.
Campo de unión target_resource. Referencia al recurso del ámbito de configuración. Es decir, el ámbito desde el que se registra el tráfico. El recurso de destino debe pertenecer al mismo proyecto que la configuración. Este campo no se admite en las configuraciones a nivel de organización. target_resource solo puede ser una de estas dos opciones:
network

string

El tráfico se registrará desde las máquinas virtuales, los túneles VPN y los adjuntos de Interconnect de la red. Formato: projects/{projectId}/global/networks/{name}
subnet

string

Se registrará el tráfico de las máquinas virtuales de la subred. Formato: projects/{projectId}/regions/{region}/subnetworks/{name}
interconnectAttachment

string

El tráfico se registrará desde la vinculación de interconexión. Formato: projects/{projectId}/regions/{region}/interconnectAttachments/{name}
vpnTunnel

string

El tráfico se registrará desde el túnel VPN. Formato: projects/{projectId}/regions/{region}/vpnTunnels/{name}
scope

enum (Scope)

Especifica el ámbito de la configuración (por ejemplo, SUBNET, NETWORK, ORGANIZATION..).

Ámbito

El ámbito de esta configuración de registro de flujo.

Enumeraciones
SCOPE_UNSPECIFIED El ámbito no está especificado.
SUBNET El recurso de destino es una subred (API Network Management).
COMPUTE_API_SUBNET El recurso de destino es una subred y la configuración procede de la API de Compute.
NETWORK El recurso de destino es una red.
VPN_TUNNEL El recurso de destino es un túnel VPN.
INTERCONNECT_ATTACHMENT El recurso de destino es una vinculación de interconexión.
ORGANIZATION La configuración se aplica a toda la organización.