Backup for GKE audit logging information

This document describes audit logging for Backup for GKE. Google Cloud services generate audit logs that record administrative and access activities within your Google Cloud resources. For more information about Cloud Audit Logs, see the following:

Service name

Backup for GKE audit logs use the service name gkebackup.googleapis.com. Filter for this service: 

    protoPayload.serviceName="gkebackup.googleapis.com"

Methods by permission type

Each IAM permission has a type property, whose value is an enum that can be one of four values: ADMIN_READ, ADMIN_WRITE, DATA_READ, or DATA_WRITE. When you call a method, Backup for GKE generates an audit log whose category is dependent on the type property of the permission required to perform the method. Methods that require an IAM permission with the type property value of DATA_READ, DATA_WRITE, or ADMIN_READ generate Data Access audit logs. Methods that require an IAM permission with the type property value of ADMIN_WRITE generate Admin Activity audit logs.

Permission type Methods
ADMIN_READ GetIamPolicy
google.cloud.gkebackup.v1.BackupForGKE.GetBackup
google.cloud.gkebackup.v1.BackupForGKE.GetBackupIndexDownloadUrl
google.cloud.gkebackup.v1.BackupForGKE.GetBackupPlan
google.cloud.gkebackup.v1.BackupForGKE.GetRestore
google.cloud.gkebackup.v1.BackupForGKE.GetRestorePlan
google.cloud.gkebackup.v1.BackupForGKE.GetVolumeBackup
google.cloud.gkebackup.v1.BackupForGKE.GetVolumeRestore
google.cloud.gkebackup.v1.BackupForGKE.ListBackupPlans
google.cloud.gkebackup.v1.BackupForGKE.ListBackups
google.cloud.gkebackup.v1.BackupForGKE.ListRestorePlans
google.cloud.gkebackup.v1.BackupForGKE.ListRestores
google.cloud.gkebackup.v1.BackupForGKE.ListVolumeBackups
google.cloud.gkebackup.v1.BackupForGKE.ListVolumeRestores
google.longrunning.Operations.GetOperation
google.longrunning.Operations.ListOperations
ADMIN_WRITE SetIamPolicy
google.cloud.gkebackup.v1.BackupForGKE.CreateBackup
google.cloud.gkebackup.v1.BackupForGKE.CreateBackupPlan
google.cloud.gkebackup.v1.BackupForGKE.CreateRestore
google.cloud.gkebackup.v1.BackupForGKE.CreateRestorePlan
google.cloud.gkebackup.v1.BackupForGKE.DeleteBackup
google.cloud.gkebackup.v1.BackupForGKE.DeleteBackupPlan
google.cloud.gkebackup.v1.BackupForGKE.DeleteRestore
google.cloud.gkebackup.v1.BackupForGKE.DeleteRestorePlan
google.cloud.gkebackup.v1.BackupForGKE.UpdateBackup
google.cloud.gkebackup.v1.BackupForGKE.UpdateBackupPlan
google.cloud.gkebackup.v1.BackupForGKE.UpdateRestore
google.cloud.gkebackup.v1.BackupForGKE.UpdateRestorePlan
google.longrunning.Operations.CancelOperation
google.longrunning.Operations.DeleteOperation

API interface audit logs

For information about how and which permissions are evaluated for each method, see the Identity and Access Management documentation for Backup for GKE.

google.cloud.gkebackup.v1.BackupForGKE

The following audit logs are associated with methods belonging to google.cloud.gkebackup.v1.BackupForGKE.

CreateBackup

  • Method: google.cloud.gkebackup.v1.BackupForGKE.CreateBackup
  • Audit log type: Admin activity
  • Permissions:
    • gkebackup.backups.create - ADMIN_WRITE
  • Method is a long-running or streaming operation: Long-running operation
  • Filter for this method: protoPayload.methodName="google.cloud.gkebackup.v1.BackupForGKE.CreateBackup"

CreateBackupPlan

  • Method: google.cloud.gkebackup.v1.BackupForGKE.CreateBackupPlan
  • Audit log type: Admin activity
  • Permissions:
    • gkebackup.backupPlans.create - ADMIN_WRITE
  • Method is a long-running or streaming operation: Long-running operation
  • Filter for this method: protoPayload.methodName="google.cloud.gkebackup.v1.BackupForGKE.CreateBackupPlan"

CreateRestore

  • Method: google.cloud.gkebackup.v1.BackupForGKE.CreateRestore
  • Audit log type: Admin activity
  • Permissions:
    • gkebackup.restores.create - ADMIN_WRITE
  • Method is a long-running or streaming operation: Long-running operation
  • Filter for this method: protoPayload.methodName="google.cloud.gkebackup.v1.BackupForGKE.CreateRestore"

CreateRestorePlan

  • Method: google.cloud.gkebackup.v1.BackupForGKE.CreateRestorePlan
  • Audit log type: Admin activity
  • Permissions:
    • gkebackup.restorePlans.create - ADMIN_WRITE
  • Method is a long-running or streaming operation: Long-running operation
  • Filter for this method: protoPayload.methodName="google.cloud.gkebackup.v1.BackupForGKE.CreateRestorePlan"

DeleteBackup

  • Method: google.cloud.gkebackup.v1.BackupForGKE.DeleteBackup
  • Audit log type: Admin activity
  • Permissions:
    • gkebackup.backups.delete - ADMIN_WRITE
  • Method is a long-running or streaming operation: Long-running operation
  • Filter for this method: protoPayload.methodName="google.cloud.gkebackup.v1.BackupForGKE.DeleteBackup"

DeleteBackupPlan

  • Method: google.cloud.gkebackup.v1.BackupForGKE.DeleteBackupPlan
  • Audit log type: Admin activity
  • Permissions:
    • gkebackup.backupPlans.delete - ADMIN_WRITE
  • Method is a long-running or streaming operation: Long-running operation
  • Filter for this method: protoPayload.methodName="google.cloud.gkebackup.v1.BackupForGKE.DeleteBackupPlan"

DeleteRestore

  • Method: google.cloud.gkebackup.v1.BackupForGKE.DeleteRestore
  • Audit log type: Admin activity
  • Permissions:
    • gkebackup.restores.delete - ADMIN_WRITE
  • Method is a long-running or streaming operation: Long-running operation
  • Filter for this method: protoPayload.methodName="google.cloud.gkebackup.v1.BackupForGKE.DeleteRestore"

DeleteRestorePlan

  • Method: google.cloud.gkebackup.v1.BackupForGKE.DeleteRestorePlan
  • Audit log type: Admin activity
  • Permissions:
    • gkebackup.restorePlans.delete - ADMIN_WRITE
  • Method is a long-running or streaming operation: Long-running operation
  • Filter for this method: protoPayload.methodName="google.cloud.gkebackup.v1.BackupForGKE.DeleteRestorePlan"

GetBackup

  • Method: google.cloud.gkebackup.v1.BackupForGKE.GetBackup
  • Audit log type: Data access
  • Permissions:
    • gkebackup.backups.get - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.gkebackup.v1.BackupForGKE.GetBackup"

GetBackupIndexDownloadUrl

  • Method: google.cloud.gkebackup.v1.BackupForGKE.GetBackupIndexDownloadUrl
  • Audit log type: Data access
  • Permissions:
    • gkebackup.backups.getBackupIndex - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.gkebackup.v1.BackupForGKE.GetBackupIndexDownloadUrl"

GetBackupPlan

  • Method: google.cloud.gkebackup.v1.BackupForGKE.GetBackupPlan
  • Audit log type: Data access
  • Permissions:
    • gkebackup.backupPlans.get - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.gkebackup.v1.BackupForGKE.GetBackupPlan"

GetRestore

  • Method: google.cloud.gkebackup.v1.BackupForGKE.GetRestore
  • Audit log type: Data access
  • Permissions:
    • gkebackup.restores.get - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.gkebackup.v1.BackupForGKE.GetRestore"

GetRestorePlan

  • Method: google.cloud.gkebackup.v1.BackupForGKE.GetRestorePlan
  • Audit log type: Data access
  • Permissions:
    • gkebackup.restorePlans.get - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.gkebackup.v1.BackupForGKE.GetRestorePlan"

GetVolumeBackup

  • Method: google.cloud.gkebackup.v1.BackupForGKE.GetVolumeBackup
  • Audit log type: Data access
  • Permissions:
    • gkebackup.volumeBackups.get - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.gkebackup.v1.BackupForGKE.GetVolumeBackup"

GetVolumeRestore

  • Method: google.cloud.gkebackup.v1.BackupForGKE.GetVolumeRestore
  • Audit log type: Data access
  • Permissions:
    • gkebackup.volumeRestores.get - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.gkebackup.v1.BackupForGKE.GetVolumeRestore"

ListBackupPlans

  • Method: google.cloud.gkebackup.v1.BackupForGKE.ListBackupPlans
  • Audit log type: Data access
  • Permissions:
    • gkebackup.backupPlans.list - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.gkebackup.v1.BackupForGKE.ListBackupPlans"

ListBackups

  • Method: google.cloud.gkebackup.v1.BackupForGKE.ListBackups
  • Audit log type: Data access
  • Permissions:
    • gkebackup.backups.list - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.gkebackup.v1.BackupForGKE.ListBackups"

ListRestorePlans

  • Method: google.cloud.gkebackup.v1.BackupForGKE.ListRestorePlans
  • Audit log type: Data access
  • Permissions:
    • gkebackup.restorePlans.list - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.gkebackup.v1.BackupForGKE.ListRestorePlans"

ListRestores

  • Method: google.cloud.gkebackup.v1.BackupForGKE.ListRestores
  • Audit log type: Data access
  • Permissions:
    • gkebackup.restores.list - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.gkebackup.v1.BackupForGKE.ListRestores"

ListVolumeBackups

  • Method: google.cloud.gkebackup.v1.BackupForGKE.ListVolumeBackups
  • Audit log type: Data access
  • Permissions:
    • gkebackup.volumeBackups.list - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.gkebackup.v1.BackupForGKE.ListVolumeBackups"

ListVolumeRestores

  • Method: google.cloud.gkebackup.v1.BackupForGKE.ListVolumeRestores
  • Audit log type: Data access
  • Permissions:
    • gkebackup.volumeRestores.list - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.gkebackup.v1.BackupForGKE.ListVolumeRestores"

UpdateBackup

  • Method: google.cloud.gkebackup.v1.BackupForGKE.UpdateBackup
  • Audit log type: Admin activity
  • Permissions:
    • gkebackup.backups.update - ADMIN_WRITE
  • Method is a long-running or streaming operation: Long-running operation
  • Filter for this method: protoPayload.methodName="google.cloud.gkebackup.v1.BackupForGKE.UpdateBackup"

UpdateBackupPlan

  • Method: google.cloud.gkebackup.v1.BackupForGKE.UpdateBackupPlan
  • Audit log type: Admin activity
  • Permissions:
    • gkebackup.backupPlans.update - ADMIN_WRITE
  • Method is a long-running or streaming operation: Long-running operation
  • Filter for this method: protoPayload.methodName="google.cloud.gkebackup.v1.BackupForGKE.UpdateBackupPlan"

UpdateRestore

  • Method: google.cloud.gkebackup.v1.BackupForGKE.UpdateRestore
  • Audit log type: Admin activity
  • Permissions:
    • gkebackup.restores.update - ADMIN_WRITE
  • Method is a long-running or streaming operation: Long-running operation
  • Filter for this method: protoPayload.methodName="google.cloud.gkebackup.v1.BackupForGKE.UpdateRestore"

UpdateRestorePlan

  • Method: google.cloud.gkebackup.v1.BackupForGKE.UpdateRestorePlan
  • Audit log type: Admin activity
  • Permissions:
    • gkebackup.restorePlans.update - ADMIN_WRITE
  • Method is a long-running or streaming operation: Long-running operation
  • Filter for this method: protoPayload.methodName="google.cloud.gkebackup.v1.BackupForGKE.UpdateRestorePlan"

google.iam.v1.IAMPolicy

The following audit logs are associated with methods belonging to google.iam.v1.IAMPolicy.

GetIamPolicy

  • Method: GetIamPolicy
  • Audit log type: Data access
  • Permissions: See IAM documentation for permissions.
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="GetIamPolicy"

SetIamPolicy

  • Method: SetIamPolicy
  • Audit log type: Admin activity
  • Permissions:
    • gkebackup.backupPlans.setIamPolicy - ADMIN_WRITE
    • gkebackup.backups.setIamPolicy - ADMIN_WRITE
    • gkebackup.restorePlans.setIamPolicy - ADMIN_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="SetIamPolicy"

google.longrunning.Operations

The following audit logs are associated with methods belonging to google.longrunning.Operations.

CancelOperation

  • Method: google.longrunning.Operations.CancelOperation
  • Audit log type: Admin activity
  • Permissions:
    • gkebackup.operations.cancel - ADMIN_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.longrunning.Operations.CancelOperation"

DeleteOperation

  • Method: google.longrunning.Operations.DeleteOperation
  • Audit log type: Admin activity
  • Permissions:
    • gkebackup.operations.delete - ADMIN_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.longrunning.Operations.DeleteOperation"

GetOperation

  • Method: google.longrunning.Operations.GetOperation
  • Audit log type: Data access
  • Permissions:
    • gkebackup.operations.get - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.longrunning.Operations.GetOperation"

ListOperations

  • Method: google.longrunning.Operations.ListOperations
  • Audit log type: Data access
  • Permissions:
    • gkebackup.operations.list - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.longrunning.Operations.ListOperations"

Methods that don't produce audit logs

A method might not produce audit logs for one or more of the following reasons:

  • It is a high volume method involving signifcant log generation and storage costs.
  • It has low auditing value.
  • Another audit or platform log already provides method coverage.

The following methods don't produce audit logs:

  • google.cloud.location.Locations.GetLocation
  • google.cloud.location.Locations.ListLocations
  • google.longrunning.Operations.WaitOperation