Información de registro de auditoría de API Gateway

En esta página, se describen los registros de auditoría que crea API Gateway como parte de los Cloud Audit Logs.

Descripción general

Los servicios de Google Cloud escriben registros de auditoría para ayudarte a responder las preguntas “¿Quién hizo qué, dónde y cuándo?”. dentro de tus recursos de Google Cloud.

Los proyectos de Google Cloud contienen solo los registros de auditoría de los recursos que están directamente dentro del proyecto de Cloud. Otros recursos de Google Cloud, como las carpetas, organizaciones y cuentas de facturación, contienen los registros de auditoría correspondientes a la entidad.

Consulta Descripción general de los registros de auditoría de Cloud para obtener una descripción general de estos registros. Para comprender mejor el formato del registro de auditoría, consulta Información sobre los registros de auditoría.

Registros de auditoría disponibles

Los siguientes tipos de registros de auditoría están disponibles para API Gateway:

Registros de auditoría de actividad del administrador

Incluye operaciones de “escritura de administrador” que escriben metadatos o información de configuración.

No puedes inhabilitar los registros de auditoría de actividad del administrador.
Registros de auditoría de acceso a los datos

Incluye operaciones de “lectura de administrador” que leen metadatos o información de configuración. También incluye las operaciones de “lectura de datos” y “escritura de datos” que leen o escriben datos proporcionados por el usuario.

Para recibir registros de auditoría de acceso a los datos, debes habilitarlos de forma explícita.

Para obtener descripciones más completas de los tipos de registros de auditoría, consulta Tipos de registros de auditoría.

Operaciones auditadas

A continuación, se resumen las operaciones de la API que corresponden a cada tipo de registro de auditoría en API Gateway:

Categoría de registros de auditoría Operaciones de API Gateway

Actividad del administrador

Categoría de registros de auditoría	Operaciones de API Gateway
Actividad del administrador	Operaciones de puerta de enlace: `CreateGateway` `UpdateGateway` `DeleteGateway` Operaciones de la API: `CreateApi` `UpdateApi` `DeleteApi` Operaciones de APIConfig: `CreateApiConfig` `UpdateApiConfig` `DeleteApiConfig` Operaciones de administración de identidades y accesos (IAM): `SetIamPolicy(Gateways)` `SetIamPolicy(APIs)` `SetIamPolicy(APIConfigs)` Operaciones: `CancelOperation` `DeleteOperation`
Registros de acceso a los datos (`ADMIN_READ`)	Operaciones de puerta de enlace: `GetGateway` `ListGateways` Operaciones de la API: `GetApi` `ListApis` Operaciones de APIConfig: `GetApiConfig` `ListApiConfigs` Operaciones de administración de identidades y accesos (IAM): `GetIamPolicy(Gateways)` `GetIamPolicy(APIs)` `GetIamPolicy(APIConfigs)` Operaciones: `GetOperation` `ListOperations` Operaciones de ubicación: `GetLocation` `ListLocations`

Operaciones de puerta de enlace:

CreateGateway
UpdateGateway
DeleteGateway

Operaciones de la API:

CreateApi
UpdateApi
DeleteApi

Operaciones de APIConfig:

CreateApiConfig
UpdateApiConfig
DeleteApiConfig

Operaciones de administración de identidades y accesos (IAM):

SetIamPolicy(Gateways)
SetIamPolicy(APIs)
SetIamPolicy(APIConfigs)

Operaciones:

CancelOperation
DeleteOperation

Registros de acceso a los datos (ADMIN_READ)

Operaciones de puerta de enlace:

GetGateway
ListGateways

Operaciones de la API:

GetApi
ListApis

Operaciones de APIConfig:

GetApiConfig
ListApiConfigs

Operaciones de administración de identidades y accesos (IAM):

GetIamPolicy(Gateways)
GetIamPolicy(APIs)
GetIamPolicy(APIConfigs)

Operaciones:

GetOperation
ListOperations

Operaciones de ubicación:

GetLocation
ListLocations

Formato de registro de auditoría

Las entradas del registro de auditoría incluyen los siguientes objetos:

La entrada de registro, que es un objeto de tipo LogEntry. Los campos útiles incluyen los siguientes:
- El campo logName contiene el ID del recurso y el tipo de registro de auditoría.
- El campo resource contiene el objetivo de la operación auditada.
- El campo timeStamp contiene la hora de la operación auditada.
- El campo protoPayload contiene la información auditada.
Los datos de registro de auditoría, que son un objeto AuditLog alojado en el campo protoPayload de la entrada de registro.
La información opcional de auditoría específica del servicio, que es un objeto específico del servicio. En las integraciones más antiguas, este objeto se guarda en el campo serviceData del objeto AuditLog. Las integraciones más recientes usan el campo metadata.

Para obtener información sobre otros campos en estos objetos, además de cómo interpretarlos, consulta Información sobre los registros de auditoría.

Nombre del registro

Los nombres de los recursos de los registros de auditoría de Cloud indican a qué proyecto de Cloud o entidad de Google Cloud de otro tipo pertenecen y si el registro contiene los datos de registro de auditoría de la actividad del administrador, el acceso a los datos, la política denegada o los eventos del sistema. Por ejemplo, el siguiente segmento muestra los nombres de registro para los registros de auditoría de actividad del administrador a nivel de proyecto y los de acceso a los datos de una organización: Las variables denotan identificadores del proyecto de Cloud y de la organización.

projects/PROJECT_ID/logs/cloudaudit.googleapis.com%2Factivity

organizations/ORGANIZATION_ID/logs/cloudaudit.googleapis.com%2Fdata_access

Nombre del servicio

Los registros de auditoría de API Gateway usan el nombre de servicio “apigateway.googleapis.com”.

Para obtener una lista completa de los nombres de los servicios de la API de Cloud Logging y su tipo de recurso supervisado correspondiente, consulta Asigna servicios a recursos.

Tipos de recursos

Los registros de auditoría de API Gateway usan el tipo de recurso "audited_resource" para todos los registros de auditoría.

Para obtener una lista de todos los tipos de recursos supervisados de Cloud Logging y la información descriptiva, consulta Tipos de recursos supervisados.

Habilita el registro de auditoría

Los registros de auditoría de actividad del administrador siempre están habilitados; no puedes inhabilitarlos.

Los registros de auditoría de acceso a los datos están inhabilitados de forma predeterminada y no se escriben, a menos que se habiliten explícitamente (excepto los registros de auditoría de acceso a los datos de BigQuery, que no pueden inhabilitarse).

Si quieres obtener instrucciones para habilitar todos o algunos de los registros de auditoría de acceso a los datos, consulta Configura los registros de acceso a los datos.

Permisos y funciones

Los permisos y las funciones de IAM determinan tu capacidad para acceder a los datos de registros de auditoría en los recursos de Google Cloud.

Cuando decidas qué funciones y permisos específicos de Logging se aplican a tu caso de uso, considera lo siguiente:

La función Visor de registros (roles/logging.viewer) te otorga acceso de solo lectura a los registros de auditoría de la actividad del administrador, la política denegada y los eventos del sistema. Si solo tienes esta función, no podrás ver los registros de auditoría de acceso a los datos que se encuentran en los buckets _Required y _Default.
La función Visor de registros privados ((roles/logging.privateLogViewer) incluye los permisos que contiene roles/logging.viewer, además de la capacidad de leer registros de auditoría de acceso a los datos en los buckets _Required y _Default.

Ten en cuenta que si estos registros privados se almacenan en buckets definidos por el usuario, cualquier usuario que tenga permisos para leer registros en esos buckets puede leer los registros privados. Para obtener más información sobre los buckets de registros, consulta Descripción general del enrutamiento y el almacenamiento.

Para obtener más información sobre los permisos y las funciones de IAM que se aplican a los datos de registros de auditoría, consulta Control de acceso con IAM.

View logs

Si deseas encontrar y ver los registros de auditoría, debes conocer el identificador de la carpeta, la organización o el proyecto de Cloud del que deseas ver la información de registro de auditoría. Además, puedes especificar otros campos LogEntry indexados, como resource.type. Para obtener más información, consulta Busca entradas de registro con rapidez.

A continuación, se muestran los nombres de los registros de auditoría, que incluyen variables para los identificadores del proyecto, la carpeta o la organización de Cloud:

   projects/PROJECT_ID/logs/cloudaudit.googleapis.com%2Factivity
   projects/PROJECT_ID/logs/cloudaudit.googleapis.com%2Fdata_access
   projects/PROJECT_ID/logs/cloudaudit.googleapis.com%2Fsystem_event
   projects/PROJECT_ID/logs/cloudaudit.googleapis.com%2Fpolicy

   folders/FOLDER_ID/logs/cloudaudit.googleapis.com%2Factivity
   folders/FOLDER_ID/logs/cloudaudit.googleapis.com%2Fdata_access
   folders/FOLDER_ID/logs/cloudaudit.googleapis.com%2Fsystem_event
   folders/FOLDER_ID/logs/cloudaudit.googleapis.com%2Fpolicy

   organizations/ORGANIZATION_ID/logs/cloudaudit.googleapis.com%2Factivity
   organizations/ORGANIZATION_ID/logs/cloudaudit.googleapis.com%2Fdata_access
   organizations/ORGANIZATION_ID/logs/cloudaudit.googleapis.com%2Fsystem_event
   organizations/ORGANIZATION_ID/logs/cloudaudit.googleapis.com%2Fpolicy

Puedes ver los registros de auditoría en Cloud Logging mediante Cloud Console, la herramienta de línea de comandos de gcloud o la API de Logging.

Console

En Cloud Console, puedes usar el Explorador de registros a fin de recuperar las entradas de registro de auditoría de tu carpeta, organización o proyecto de Cloud:

En Cloud Console, ve a la página Logging > Explorador de registros.

Ir al Explorador de registros

Nota: Si usas la página Visor de registros heredado, cambia a la página Explorador de registros.
En la página Explorador de registros, selecciona una organización, una carpeta o un proyecto de Cloud existente.
En el panel Compilador de consultas, sigue estos pasos:
- En Tipo de recurso, selecciona el recurso de Google Cloud cuyos registros de auditoría deseas ver.
- En Nombre del registro, selecciona el tipo de registro de auditoría que deseas ver:
  - En el caso de los registros de auditoría de la actividad del administrador, selecciona activity.
  - En los registros de auditoría de acceso a los datos, selecciona data_access.
  - En el caso de los registros de auditoría de eventos del sistema, selecciona system_event.
  - En el caso de los registros de auditoría de política denegada, selecciona la política.
Si no ves estas opciones, significa que no hay registros de auditoría de ese tipo disponibles en la carpeta, la organización o el proyecto de Cloud.

Para obtener más información sobre las consultas mediante el Explorador de registros, visita Crea consultas de registro.

gcloud

La herramienta de línea de comandos de gcloud proporciona una interfaz de línea de comandos para la API de Cloud Logging. Proporciona un PROJECT_ID, FOLDER_ID o ORGANIZATION_ID válido en cada uno de los nombres de registro.

Para leer las entradas de registro de auditoría a nivel de proyecto de Cloud, ejecuta el siguiente comando:

gcloud logging read "logName : projects/PROJECT_ID/logs/cloudaudit.googleapis.com" --project=PROJECT_ID

Para leer las entradas del registro de auditoría a nivel de las carpetas, ejecuta el siguiente comando:

gcloud logging read "logName : folders/FOLDER_ID/logs/cloudaudit.googleapis.com" --folder=FOLDER_ID

Para leer las entradas del registro de auditoría a nivel de organización, ejecuta el siguiente comando:

gcloud logging read "logName : organizations/ORGANIZATION_ID/logs/cloudaudit.googleapis.com" --organization=ORGANIZATION_ID

Para obtener más información sobre el uso de la herramienta de gcloud, consulta Lee las entradas de registro.

API

Cuando crees tus consultas, reemplaza las variables por valores válidos. Sustituye el nombre de registro de auditoría adecuado a nivel de proyecto, de carpeta o de organización, o usa los identificadores enumerados en los nombres de registro de auditoría. Por ejemplo, si tu consulta incluye un PROJECT_ID, el identificador del proyecto que proporciones debe hacer referencia al proyecto de Cloud que se encuentra seleccionado.

Si deseas usar la API de Logging para ver tus entradas de registro de auditoría, haz lo siguiente:

Ve a la sección Probar esta API en la documentación del método entries.list.
Ingresa lo siguiente en el cuerpo de la solicitud del formulario Prueba esta API. Si haces clic en este formulario prepropagado, se completará el cuerpo de la solicitud de manera automática, pero deberás proporcionar un PROJECT_ID válido para cada nombre de registro.
```
{
  "resourceNames": [
    "projects/PROJECT_ID"
  ],
  "pageSize": 5,
  "filter": "logName : projects/PROJECT_ID/logs/cloudaudit.googleapis.com"
}
```
Haz clic en Ejecutar.

Para obtener más detalles sobre las consultas, visita Lenguaje de consulta de Logging.

Para ver un ejemplo de una entrada de registro de auditoría y cómo encontrar la información más importante en ella, consulta Ejemplo de entrada de registro de auditoría.

Enruta registros de auditoría

Puedes enrutar registros de auditoría a destinos compatibles de la misma manera en la que enrutas otros tipos de registros. Estos son algunos de los motivos por los que es posible que desees enrutar tus registros de auditoría:

Para mantener los registros de auditoría por un período más extenso o usar capacidades de búsqueda más potentes, puedes enrutar copias de tus registros de auditoría a Cloud Storage, BigQuery o Pub/Sub. Mediante Pub/Sub, puedes enrutar a otras aplicaciones, otros repositorios y a terceros.
Para administrar los registros de auditoría en toda la organización, puedes crear receptores agregados que puedan enrutar registros desde cualquier proyecto de Cloud de la organización o desde todos los proyectos.

Si tus registros de auditoría de acceso a los datos habilitados sobrepasan las asignaciones de registros de los proyectos de Cloud, puedes crear receptores que excluyan los registros de auditoría de acceso a los datos de Logging.

Si deseas obtener instrucciones para enrutar los registros, consulta Configura receptores.

Precios

Los registros de auditoría de actividad del administrador y los registros de auditoría de eventos del sistema son gratuitos.

Se te cobra por los registros de auditoría de acceso a los datos y los registros de auditoría de política denegada.

Para obtener más información sobre los precios de Cloud Logging, consulta Precios de Google Cloud's operations suite: Cloud Logging.