Method: projects.locations.vpcFlowLogsConfigs.showEffectiveFlowLogsConfigs

vpcFlowLogsConfigs.showEffectiveFlowLogsConfigs devuelve una lista de todos los parámetros de configuración de los registros de flujo de VPC aplicables a un recurso especificado.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
parent

string

Obligatorio. Es el recurso superior de la VpcFlowLogsConfig, especificado en el formato siguiente: projects/{projectId}/locations/global

La autorización requiere el siguiente permiso de IAM en el recurso especificado parent:

  • networkmanagement.vpcflowlogsconfigs.list

Parámetros de consulta

Parámetros
resource

string

Obligatorio. Es el recurso para el que se obtiene la configuración de los registros de flujo de VPC vigentes. El recurso debe pertenecer al mismo proyecto que el recurso principal. El recurso debe ser una red, una subred, un adjunto de interconexión, un túnel VPN o un proyecto.
pageSize

integer

Opcional. Es la cantidad de EffectiveVpcFlowLogsConfigs que se devolverán. El valor predeterminado es 30.
pageToken

string

Opcional. Es un token de página de una consulta anterior, como se devolvió en nextPageToken.
filter

string

Opcional. Enumera las EffectiveVpcFlowLogsConfigs que coinciden con la expresión del 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 para el método vpcFlowLogsConfigs.showEffectiveFlowLogsConfigs.

Si se ejecuta con éxito, el cuerpo de la respuesta contendrá datos con la estructura siguiente:

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

object (EffectiveVpcFlowLogsConfig)

Es la lista de los parámetros de configuración de los registros de flujo de VPC vigentes.
nextPageToken

string

Es el token de página que sirve para recuperar el siguiente conjunto de parámetros de configuración.
unreachable[]

string

Son las ubicaciones que no se pudieron alcanzar (cuando se consultaron 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 Authentication Overview.

EffectiveVpcFlowLogsConfig

Es la configuración que permite generar una respuesta a la 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

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

  • Para parámetros de configuración a nivel de proyecto: projects/{projectId}/locations/global/vpcFlowLogsConfigs/{vpcFlowLogsConfigId}

  • Para parámetros de configuración 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 acceso a la subred: projects/{projectId}/regions/{region}/subnetworks/{subnet_id}
metadataFields[]

string

Son los campos de metadatos personalizados que se incluirán en los registros de flujo de VPC que se informen. Solo se pueden especificar si “Metadatos” se estableció en CUSTOM_METADATA.
state

enum (State)

Es el estado de la configuración de los registros de flujo de VPC. El valor predeterminado es HABILITADA. Cuando crees una configuración nueva, debes habilitarla. Si se establece state=DISABLED, se pausará la generación de registros para esta configuración.
aggregationInterval

enum (AggregationInterval)

Es el intervalo de agregación de los registros. El valor predeterminado es INTERVAL_5_SEC.
flowSampling

number

El valor del campo debe ser de (0, 1]. Es la tasa de muestreo de los registros de flujo de VPC, en la que 1.0 significa que se informan todos los registros recopilados. No se permite establecer la tasa de muestreo en 0.0. Si deseas 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 agregar todos, ninguno o un subconjunto de los campos de metadatos a los registros de flujo de VPC que se informan. El valor predeterminado es INCLUDE_ALL_METADATA.
filterExpr

string

Es el 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 los parámetros de configuración de la organización. Si no se especifica en los parámetros de configuración de la organización, se establecerá en CROSS_PROJECT_METADATA_ENABLED.
Campo de unión target_resource. Es la referencia al recurso del permiso de la configuración. Es decir, el permiso desde el que se registra el tráfico. El recurso de destino debe pertenecer al mismo proyecto que la configuración. Este campo no es compatible con los parámetros de configuración a nivel de organización. target_resource puede ser solo uno de los siguientes parámetros:
network

string

Se registrará el tráfico de las VMs, los túneles VPN y los adjuntos de interconexión dentro de la red. Formato: projects/{projectId}/global/networks/{name}
subnet

string

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

string

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

string

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

enum (Scope)

Especifica el permiso de la configuración (p. ej., SUBNET, NETWORK, ORGANIZATION…).

Permiso

Es el permiso de esta configuración de registro de flujo.

Enums
SCOPE_UNSPECIFIED El permiso no se especifica.
SUBNET El recurso de destino es una subred (API de administración de redes).
COMPUTE_API_SUBNET El recurso de destino es una subred, y la configuración proviene 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 un adjunto de interconexión.
ORGANIZATION La configuración se aplica a toda la organización.