Geração de registros de auditoria do API Gateway

Neste documento, descrevemos a geração de registros de auditoria do API Gateway.Os serviços do Google Cloud geram registros de auditoria das atividades administrativas e de acesso nos recursos do Google Cloud . Para mais informações sobre os Registros de auditoria do Cloud, consulte:

Nome do serviço

Os registros de auditoria do API Gateway usam o nome de serviço apigateway.googleapis.com. Filtrar por este serviço: 

    protoPayload.serviceName="apigateway.googleapis.com"

Métodos por tipo de permissão

Cada permissão do IAM tem uma propriedade type, que tem o valor de um tipo enumerado que pode ser um dos quatro valores: ADMIN_READ, ADMIN_WRITE, DATA_READ ou DATA_WRITE. Quando você chama um método, o API Gateway gera um registro de auditoria com categoria dependente da propriedade type da permissão necessária para executar o método. Métodos que exigem uma permissão do IAM com o valor da propriedade type de DATA_READ, DATA_WRITE ou ADMIN_READ geram registros de auditoria de acesso aos dados. Métodos que exigem uma permissão do IAM com o valor da propriedade type de ADMIN_WRITE geram registros de auditoria de Atividade do administrador.

Os métodos de API na lista a seguir marcados com (LRO) são operações de longa duração (LROs). Esses métodos geralmente geram duas entradas de registro de auditoria: uma quando a operação começa e outra quando ela termina. Para mais informações, consulte Registros de auditoria para operações de longa duração.
Tipo de permissão Métodos
ADMIN_READ google.cloud.apigateway.v1.ApiGatewayService.GetApi
google.cloud.apigateway.v1.ApiGatewayService.GetApiConfig
google.cloud.apigateway.v1.ApiGatewayService.GetGateway
google.cloud.apigateway.v1.ApiGatewayService.ListApiConfigs
google.cloud.apigateway.v1.ApiGatewayService.ListApis
google.cloud.apigateway.v1.ApiGatewayService.ListGateways
google.cloud.apigateway.v1beta.ApiGatewayService.GetApi
google.cloud.apigateway.v1beta.ApiGatewayService.GetApiConfig
google.cloud.apigateway.v1beta.ApiGatewayService.GetGateway
google.cloud.apigateway.v1beta.ApiGatewayService.ListApis
GetIamPolicy
google.longrunning.Operations.GetOperation
google.longrunning.Operations.ListOperations
ADMIN_WRITE google.cloud.apigateway.v1.ApiGatewayService.CreateApi (LRO)
google.cloud.apigateway.v1.ApiGatewayService.CreateApiConfig (LRO)
google.cloud.apigateway.v1.ApiGatewayService.CreateGateway (LRO)
google.cloud.apigateway.v1.ApiGatewayService.DeleteApi (LRO)
google.cloud.apigateway.v1.ApiGatewayService.DeleteApiConfig (LRO)
google.cloud.apigateway.v1.ApiGatewayService.DeleteGateway (LRO)
google.cloud.apigateway.v1.ApiGatewayService.UpdateApi (LRO)
google.cloud.apigateway.v1.ApiGatewayService.UpdateApiConfig (LRO)
google.cloud.apigateway.v1.ApiGatewayService.UpdateGateway (LRO)
google.cloud.apigateway.v1beta.ApiGatewayService.CreateApi (LRO)
google.cloud.apigateway.v1beta.ApiGatewayService.CreateApiConfig (LRO)
google.cloud.apigateway.v1beta.ApiGatewayService.CreateGateway (LRO)
google.cloud.apigateway.v1beta.ApiGatewayService.DeleteApi (LRO)
google.cloud.apigateway.v1beta.ApiGatewayService.DeleteApiConfig (LRO)
google.cloud.apigateway.v1beta.ApiGatewayService.DeleteGateway (LRO)
google.cloud.apigateway.v1beta.ApiGatewayService.UpdateApi (LRO)
google.cloud.apigateway.v1beta.ApiGatewayService.UpdateApiConfig (LRO)
google.cloud.apigateway.v1beta.ApiGatewayService.UpdateGateway (LRO)
SetIamPolicy
google.longrunning.Operations.CancelOperation
google.longrunning.Operations.DeleteOperation

Registros de auditoria da interface da API

Para informações sobre como e quais permissões são avaliadas para cada método, consulte a documentação do Identity and Access Management para o API Gateway.

google.cloud.apigateway.v1.ApiGatewayService

Os registros de auditoria a seguir estão associados a métodos que pertencem a google.cloud.apigateway.v1.ApiGatewayService.

CreateApi

  • Método: google.cloud.apigateway.v1.ApiGatewayService.CreateApi
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • apigateway.apis.create - ADMIN_WRITE
  • O método é uma operação de streaming ou de longa duração: operação de longa duração
  • Filtrar para este método: protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.CreateApi"

CreateApiConfig

  • Método: google.cloud.apigateway.v1.ApiGatewayService.CreateApiConfig
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • apigateway.apiconfigs.create - ADMIN_WRITE
  • O método é uma operação de streaming ou de longa duração: operação de longa duração
  • Filtrar para este método: protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.CreateApiConfig"

CreateGateway

  • Método: google.cloud.apigateway.v1.ApiGatewayService.CreateGateway
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • apigateway.gateways.create - ADMIN_WRITE
  • O método é uma operação de streaming ou de longa duração: operação de longa duração
  • Filtrar para este método: protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.CreateGateway"

DeleteApi

  • Método: google.cloud.apigateway.v1.ApiGatewayService.DeleteApi
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • apigateway.apis.delete - ADMIN_WRITE
  • O método é uma operação de streaming ou de longa duração: operação de longa duração
  • Filtrar para este método: protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.DeleteApi"

DeleteApiConfig

  • Método: google.cloud.apigateway.v1.ApiGatewayService.DeleteApiConfig
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • apigateway.apiconfigs.delete - ADMIN_WRITE
  • O método é uma operação de streaming ou de longa duração: operação de longa duração
  • Filtrar para este método: protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.DeleteApiConfig"

DeleteGateway

  • Método: google.cloud.apigateway.v1.ApiGatewayService.DeleteGateway
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • apigateway.gateways.delete - ADMIN_WRITE
  • O método é uma operação de streaming ou de longa duração: operação de longa duração
  • Filtrar para este método: protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.DeleteGateway"

GetApi

  • Método: google.cloud.apigateway.v1.ApiGatewayService.GetApi
  • Tipo de registro de auditoria: acesso a dados
  • Permissões:
    • apigateway.apis.get - ADMIN_READ
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.GetApi"

GetApiConfig

  • Método: google.cloud.apigateway.v1.ApiGatewayService.GetApiConfig
  • Tipo de registro de auditoria: acesso a dados
  • Permissões:
    • apigateway.apiconfigs.get - ADMIN_READ
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.GetApiConfig"

GetGateway

  • Método: google.cloud.apigateway.v1.ApiGatewayService.GetGateway
  • Tipo de registro de auditoria: acesso a dados
  • Permissões:
    • apigateway.gateways.get - ADMIN_READ
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.GetGateway"

ListApiConfigs

  • Método: google.cloud.apigateway.v1.ApiGatewayService.ListApiConfigs
  • Tipo de registro de auditoria: acesso a dados
  • Permissões:
    • apigateway.apiconfigs.list - ADMIN_READ
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.ListApiConfigs"

ListApis

  • Método: google.cloud.apigateway.v1.ApiGatewayService.ListApis
  • Tipo de registro de auditoria: acesso a dados
  • Permissões:
    • apigateway.apis.list - ADMIN_READ
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.ListApis"

ListGateways

  • Método: google.cloud.apigateway.v1.ApiGatewayService.ListGateways
  • Tipo de registro de auditoria: acesso a dados
  • Permissões:
    • apigateway.gateways.list - ADMIN_READ
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.ListGateways"

UpdateApi

  • Método: google.cloud.apigateway.v1.ApiGatewayService.UpdateApi
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • apigateway.apis.update - ADMIN_WRITE
  • O método é uma operação de streaming ou de longa duração: operação de longa duração
  • Filtrar para este método: protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.UpdateApi"

UpdateApiConfig

  • Método: google.cloud.apigateway.v1.ApiGatewayService.UpdateApiConfig
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • apigateway.apiconfigs.update - ADMIN_WRITE
  • O método é uma operação de streaming ou de longa duração: operação de longa duração
  • Filtrar para este método: protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.UpdateApiConfig"

UpdateGateway

  • Método: google.cloud.apigateway.v1.ApiGatewayService.UpdateGateway
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • apigateway.gateways.update - ADMIN_WRITE
  • O método é uma operação de streaming ou de longa duração: operação de longa duração
  • Filtrar para este método: protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.UpdateGateway"

google.cloud.apigateway.v1beta.ApiGatewayService

Os registros de auditoria a seguir estão associados a métodos que pertencem a google.cloud.apigateway.v1beta.ApiGatewayService.

CreateApi

  • Método: google.cloud.apigateway.v1beta.ApiGatewayService.CreateApi
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • apigateway.apis.create - ADMIN_WRITE
  • O método é uma operação de streaming ou de longa duração: operação de longa duração
  • Filtrar para este método: protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.CreateApi"

CreateApiConfig

  • Método: google.cloud.apigateway.v1beta.ApiGatewayService.CreateApiConfig
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • apigateway.apiconfigs.create - ADMIN_WRITE
  • O método é uma operação de streaming ou de longa duração: operação de longa duração
  • Filtrar para este método: protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.CreateApiConfig"

CreateGateway

  • Método: google.cloud.apigateway.v1beta.ApiGatewayService.CreateGateway
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • apigateway.gateways.create - ADMIN_WRITE
  • O método é uma operação de streaming ou de longa duração: operação de longa duração
  • Filtrar para este método: protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.CreateGateway"

DeleteApi

  • Método: google.cloud.apigateway.v1beta.ApiGatewayService.DeleteApi
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • apigateway.apis.delete - ADMIN_WRITE
  • O método é uma operação de streaming ou de longa duração: operação de longa duração
  • Filtrar para este método: protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.DeleteApi"

DeleteApiConfig

  • Método: google.cloud.apigateway.v1beta.ApiGatewayService.DeleteApiConfig
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • apigateway.apiconfigs.delete - ADMIN_WRITE
  • O método é uma operação de streaming ou de longa duração: operação de longa duração
  • Filtrar para este método: protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.DeleteApiConfig"

DeleteGateway

  • Método: google.cloud.apigateway.v1beta.ApiGatewayService.DeleteGateway
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • apigateway.gateways.delete - ADMIN_WRITE
  • O método é uma operação de streaming ou de longa duração: operação de longa duração
  • Filtrar para este método: protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.DeleteGateway"

GetApi

  • Método: google.cloud.apigateway.v1beta.ApiGatewayService.GetApi
  • Tipo de registro de auditoria: acesso a dados
  • Permissões:
    • apigateway.apis.get - ADMIN_READ
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.GetApi"

GetApiConfig

  • Método: google.cloud.apigateway.v1beta.ApiGatewayService.GetApiConfig
  • Tipo de registro de auditoria: acesso a dados
  • Permissões:
    • apigateway.apiconfigs.get - ADMIN_READ
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.GetApiConfig"

GetGateway

  • Método: google.cloud.apigateway.v1beta.ApiGatewayService.GetGateway
  • Tipo de registro de auditoria: acesso a dados
  • Permissões:
    • apigateway.gateways.get - ADMIN_READ
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.GetGateway"

ListApis

  • Método: google.cloud.apigateway.v1beta.ApiGatewayService.ListApis
  • Tipo de registro de auditoria: acesso a dados
  • Permissões:
    • apigateway.apis.list - ADMIN_READ
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.ListApis"

UpdateApi

  • Método: google.cloud.apigateway.v1beta.ApiGatewayService.UpdateApi
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • apigateway.apis.update - ADMIN_WRITE
  • O método é uma operação de streaming ou de longa duração: operação de longa duração
  • Filtrar para este método: protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.UpdateApi"

UpdateApiConfig

  • Método: google.cloud.apigateway.v1beta.ApiGatewayService.UpdateApiConfig
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • apigateway.apiconfigs.update - ADMIN_WRITE
  • O método é uma operação de streaming ou de longa duração: operação de longa duração
  • Filtrar para este método: protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.UpdateApiConfig"

UpdateGateway

  • Método: google.cloud.apigateway.v1beta.ApiGatewayService.UpdateGateway
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • apigateway.gateways.update - ADMIN_WRITE
  • O método é uma operação de streaming ou de longa duração: operação de longa duração
  • Filtrar para este método: protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.UpdateGateway"

google.iam.v1.IAMPolicy

Os registros de auditoria a seguir estão associados a métodos que pertencem a google.iam.v1.IAMPolicy.

GetIamPolicy

  • Método: GetIamPolicy
  • Tipo de registro de auditoria: acesso a dados
  • Permissões:
    • apigateway.apis.getIamPolicy - ADMIN_READ
    • apigateway.gateways.getIamPolicy - ADMIN_READ
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="GetIamPolicy"

SetIamPolicy

  • Método: SetIamPolicy
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • apigateway.apiconfigs.setIamPolicy - ADMIN_WRITE
    • apigateway.apis.setIamPolicy - ADMIN_WRITE
    • apigateway.gateways.setIamPolicy - ADMIN_WRITE
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="SetIamPolicy"

google.longrunning.Operations

Os registros de auditoria a seguir estão associados a métodos que pertencem a google.longrunning.Operations.

CancelOperation

  • Método: google.longrunning.Operations.CancelOperation
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • apigateway.operations.cancel - ADMIN_WRITE
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.longrunning.Operations.CancelOperation"

DeleteOperation

  • Método: google.longrunning.Operations.DeleteOperation
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • apigateway.operations.delete - ADMIN_WRITE
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.longrunning.Operations.DeleteOperation"

GetOperation

  • Método: google.longrunning.Operations.GetOperation
  • Tipo de registro de auditoria: acesso a dados
  • Permissões:
    • apigateway.operations.get - ADMIN_READ
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.longrunning.Operations.GetOperation"

ListOperations

  • Método: google.longrunning.Operations.ListOperations
  • Tipo de registro de auditoria: acesso a dados
  • Permissões:
    • apigateway.operations.list - ADMIN_READ
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.longrunning.Operations.ListOperations"

Métodos que não geram registros de auditoria

Um método pode não gerar registros de auditoria por um ou mais dos seguintes motivos:

  • É um método de alto volume que envolve geração de registros significativos e custos de armazenamento.
  • Tem pouco valor para a auditoria.
  • Outro registro de auditoria ou plataforma já oferece cobertura do método.

Os métodos abaixo não geram registros de auditoria:

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