BigQuery Reservation API audit logging

This document describes audit logging for BigQuery Reservation API. Google Cloud servicesgenerate audit logs that record administrative and access activities within your Google Cloud resources.For more information about Cloud Audit Logs, see the following:

• Types of audit logs
• Audit log entry structure
• Storing and routing audit logs
• Cloud Logging pricing summary
• Enable Data Access audit logs

Service name

BigQuery Reservation API audit logs use the service namebigqueryreservation.googleapis.com.Filter for this service:

protoPayload.serviceName="bigqueryreservation.googleapis.com"

Methods by permission type

Each IAM permission has atype property, whose value is an enumthat can be one of four values:ADMIN_READ,ADMIN_WRITE,DATA_READ, orDATA_WRITE. When you call a method,BigQuery Reservation API generates an audit log whose category is dependent on thetype property of the permission required to perform the method.Methods that require an IAM permission with thetype property valueofDATA_READ,DATA_WRITE, orADMIN_READ generateData Access audit logs.Methods that require an IAM permission with thetype property valueofADMIN_WRITE generateAdmin Activity audit logs.

API interface audit logs

For information about how and which permissions are evaluated for each method,see theIdentity and Access Management documentation for BigQuery Reservation API.

google.cloud.bigquery.reservation.v1.ReservationService

The following audit logs are associated with methods belonging togoogle.cloud.bigquery.reservation.v1.ReservationService.

CreateAssignment

• Method:google.cloud.bigquery.reservation.v1.ReservationService.CreateAssignment
  
• Audit log type:Admin activity
  
• Permissions:
  • bigquery.reservationAssignments.create - ADMIN_WRITE
• Method is a long-running or streaming operation:No.
  
• Filter for this method: protoPayload.methodName="google.cloud.bigquery.reservation.v1.ReservationService.CreateAssignment"
  

CreateCapacityCommitment

• Method:google.cloud.bigquery.reservation.v1.ReservationService.CreateCapacityCommitment
  
• Audit log type:Admin activity
  
• Permissions:
  • bigquery.capacityCommitments.create - ADMIN_WRITE
• Method is a long-running or streaming operation:No.
  
• Filter for this method: protoPayload.methodName="google.cloud.bigquery.reservation.v1.ReservationService.CreateCapacityCommitment"
  

CreateReservation

• Method:google.cloud.bigquery.reservation.v1.ReservationService.CreateReservation
  
• Audit log type:Admin activity
  
• Permissions:
  • bigquery.reservations.create - ADMIN_WRITE
• Method is a long-running or streaming operation:No.
  
• Filter for this method: protoPayload.methodName="google.cloud.bigquery.reservation.v1.ReservationService.CreateReservation"
  

DeleteAssignment

• Method:google.cloud.bigquery.reservation.v1.ReservationService.DeleteAssignment
  
• Audit log type:Admin activity
  
• Permissions:
  • bigquery.reservationAssignments.delete - ADMIN_WRITE
• Method is a long-running or streaming operation:No.
  
• Filter for this method: protoPayload.methodName="google.cloud.bigquery.reservation.v1.ReservationService.DeleteAssignment"
  

DeleteCapacityCommitment

• Method:google.cloud.bigquery.reservation.v1.ReservationService.DeleteCapacityCommitment
  
• Audit log type:Admin activity
  
• Permissions:
  • bigquery.capacityCommitments.delete - ADMIN_WRITE
• Method is a long-running or streaming operation:No.
  
• Filter for this method: protoPayload.methodName="google.cloud.bigquery.reservation.v1.ReservationService.DeleteCapacityCommitment"
  

DeleteReservation

• Method:google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservation
  
• Audit log type:Admin activity
  
• Permissions:
  • bigquery.reservations.delete - ADMIN_WRITE
• Method is a long-running or streaming operation:No.
  
• Filter for this method: protoPayload.methodName="google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservation"
  

FailoverReservation

• Method:google.cloud.bigquery.reservation.v1.ReservationService.FailoverReservation
  
• Audit log type:Admin activity
  
• Permissions:
  • bigquery.reservations.update - ADMIN_WRITE
• Method is a long-running or streaming operation:No.
  
• Filter for this method: protoPayload.methodName="google.cloud.bigquery.reservation.v1.ReservationService.FailoverReservation"
  

GetBiReservation

• Method:google.cloud.bigquery.reservation.v1.ReservationService.GetBiReservation
  
• Audit log type:Data access
  
• Permissions:
  • bigquery.bireservations.get - ADMIN_READ
• Method is a long-running or streaming operation:No.
  
• Filter for this method: protoPayload.methodName="google.cloud.bigquery.reservation.v1.ReservationService.GetBiReservation"
  

GetCapacityCommitment

• Method:google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitment
  
• Audit log type:Data access
  
• Permissions:
  • bigquery.capacityCommitments.get - ADMIN_READ
• Method is a long-running or streaming operation:No.
  
• Filter for this method: protoPayload.methodName="google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitment"
  

GetReservation

• Method:google.cloud.bigquery.reservation.v1.ReservationService.GetReservation
  
• Audit log type:Data access
  
• Permissions:
  • bigquery.reservations.get - ADMIN_READ
• Method is a long-running or streaming operation:No.
  
• Filter for this method: protoPayload.methodName="google.cloud.bigquery.reservation.v1.ReservationService.GetReservation"
  

ListAssignments

• Method:google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments
  
• Audit log type:Data access
  
• Permissions:
  • bigquery.reservationAssignments.list - ADMIN_READ
• Method is a long-running or streaming operation:No.
  
• Filter for this method: protoPayload.methodName="google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments"
  

ListCapacityCommitments

• Method:google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments
  
• Audit log type:Data access
  
• Permissions:
  • bigquery.capacityCommitments.list - ADMIN_READ
• Method is a long-running or streaming operation:No.
  
• Filter for this method: protoPayload.methodName="google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments"
  

ListReservations

• Method:google.cloud.bigquery.reservation.v1.ReservationService.ListReservations
  
• Audit log type:Data access
  
• Permissions:
  • bigquery.reservations.list - ADMIN_READ
• Method is a long-running or streaming operation:No.
  
• Filter for this method: protoPayload.methodName="google.cloud.bigquery.reservation.v1.ReservationService.ListReservations"
  

MergeCapacityCommitments

• Method:google.cloud.bigquery.reservation.v1.ReservationService.MergeCapacityCommitments
  
• Audit log type:Admin activity
  
• Permissions:
  • bigquery.capacityCommitments.update - ADMIN_WRITE
• Method is a long-running or streaming operation:No.
  
• Filter for this method: protoPayload.methodName="google.cloud.bigquery.reservation.v1.ReservationService.MergeCapacityCommitments"
  

MoveAssignment

• Method:google.cloud.bigquery.reservation.v1.ReservationService.MoveAssignment
  
• Audit log type:Admin activity
  
• Permissions:
  • bigquery.reservationAssignments.create - ADMIN_WRITE
  • bigquery.reservationAssignments.delete - ADMIN_WRITE
• Method is a long-running or streaming operation:No.
  
• Filter for this method: protoPayload.methodName="google.cloud.bigquery.reservation.v1.ReservationService.MoveAssignment"
  

SearchAllAssignments

• Method:google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments
  
• Audit log type:Data access
  
• Permissions:
  • bigquery.reservationAssignments.search - ADMIN_READ
• Method is a long-running or streaming operation:No.
  
• Filter for this method: protoPayload.methodName="google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments"
  

SearchAssignments

• Method:google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments
  
• Audit log type:Data access
  
• Permissions:
  • bigquery.reservationAssignments.search - ADMIN_READ
• Method is a long-running or streaming operation:No.
  
• Filter for this method: protoPayload.methodName="google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments"
  

SplitCapacityCommitment

• Method:google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment
  
• Audit log type:Admin activity
  
• Permissions:
  • bigquery.capacityCommitments.update - ADMIN_WRITE
• Method is a long-running or streaming operation:No.
  
• Filter for this method: protoPayload.methodName="google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment"
  

UpdateAssignment

• Method:google.cloud.bigquery.reservation.v1.ReservationService.UpdateAssignment
  
• Audit log type:Admin activity
  
• Permissions:
  • bigquery.reservationAssignments.update - ADMIN_WRITE
• Method is a long-running or streaming operation:No.
  
• Filter for this method: protoPayload.methodName="google.cloud.bigquery.reservation.v1.ReservationService.UpdateAssignment"
  

UpdateBiReservation

• Method:google.cloud.bigquery.reservation.v1.ReservationService.UpdateBiReservation
  
• Audit log type:Admin activity
  
• Permissions:
  • bigquery.bireservations.update - ADMIN_WRITE
• Method is a long-running or streaming operation:No.
  
• Filter for this method: protoPayload.methodName="google.cloud.bigquery.reservation.v1.ReservationService.UpdateBiReservation"
  

UpdateCapacityCommitment

• Method:google.cloud.bigquery.reservation.v1.ReservationService.UpdateCapacityCommitment
  
• Audit log type:Admin activity
  
• Permissions:
  • bigquery.capacityCommitments.update - ADMIN_WRITE
• Method is a long-running or streaming operation:No.
  
• Filter for this method: protoPayload.methodName="google.cloud.bigquery.reservation.v1.ReservationService.UpdateCapacityCommitment"
  

UpdateReservation

• Method:google.cloud.bigquery.reservation.v1.ReservationService.UpdateReservation
  
• Audit log type:Admin activity
  
• Permissions:
  • bigquery.reservations.update - ADMIN_WRITE
• Method is a long-running or streaming operation:No.
  
• Filter for this method: protoPayload.methodName="google.cloud.bigquery.reservation.v1.ReservationService.UpdateReservation"
  

Audit Log examples for BigQuery Reservations usage

The following examples useAuditLog messagesto analyzeBigQuery Reservations usage.

Example: Find users who purchased slots

This query shows the email address of the users who purchased slots.

#standardSQLSELECTprotopayload_auditlog.requestMetadata.requestAttributes.timerequest_time,protopayload_auditlog.methodName,protopayload_auditlog.authenticationInfo.principalEmail,JSON_QUERY(protopayload_auditlog.requestJson,"$.capacityCommitment.slotCount")slots,FROM`my-project-id.auditlog_dataset.cloudaudit_googleapis_com_activity`WHEREprotopayload_auditlog.methodNamelike"%CreateCapacityCommitment%"ORDERbyrequest_time

Example: History of a project assignment

This query shows the history of a project's reservation assignments.

#standardSQLSELECTprotopayload_auditlog.requestMetadata.requestAttributes.timerequest_time,protopayload_auditlog.methodName,protopayload_auditlog.authenticationInfo.principalEmail,JSON_QUERY(protopayload_auditlog.requestJson,"$.assignment.assignee")assignee,JSON_QUERY(protopayload_auditlog.requestJson,"$.assignment.jobType")job_type,FROM`my-project-id.auditlog_dataset.cloudaudit_googleapis_com_activity`WHEREprotopayload_auditlog.methodNamelike"%Assignment%"ANDJSON_QUERY(protopayload_auditlog.requestJson,"$.assignment.assignee")like"%OTHERPROJECTID%"ORDERbyrequest_time