Geração de registros de auditoria do gerenciamento de APIs da Apigee

Neste documento, descrevemos a geração de registros de auditoria para o gerenciamento de APIs da Apigee. Os serviços do Google Cloud geram registros de auditoria que registram 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 gerenciamento de APIs da Apigee usam o nome de serviço apim.googleapis.com. Filtrar por este serviço: 

    protoPayload.serviceName="apim.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 gerenciamento de APIs da Apigee 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.

Tipo de permissão Métodos
ADMIN_READ google.cloud.apim.v1alpha.ApiDiscoveryObservation.GetObservationJob
google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListApiObservationTags
google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListObservationJobs
google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListObservationSources
ADMIN_WRITE google.cloud.apim.v1alpha.ApiDiscoveryObservation.BatchEditTagsApiObservations
google.cloud.apim.v1alpha.ApiDiscoveryObservation.CreateObservationJob
google.cloud.apim.v1alpha.ApiDiscoveryObservation.CreateObservationSource
google.cloud.apim.v1alpha.ApiDiscoveryObservation.DeleteObservationJob
google.cloud.apim.v1alpha.ApiDiscoveryObservation.DeleteObservationSource
google.cloud.apim.v1alpha.ApiDiscoveryObservation.DisableObservationJob
google.cloud.apim.v1alpha.ApiDiscoveryObservation.EnableObservationJob
DATA_READ google.cloud.apim.v1alpha.ApiDiscoveryObservation.GetApiObservation
google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListApiObservations
google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListApiOperations

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 gerenciamento de APIs da Apigee.

google.cloud.apim.v1alpha.ApiDiscoveryObservation

Os registros de auditoria a seguir estão associados a métodos que pertencem a google.cloud.apim.v1alpha.ApiDiscoveryObservation.

BatchEditTagsApiObservations

  • Método: google.cloud.apim.v1alpha.ApiDiscoveryObservation.BatchEditTagsApiObservations
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • apim.apiObservations.batchEditTags - ADMIN_WRITE
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.BatchEditTagsApiObservations"

CreateObservationJob

  • Método: google.cloud.apim.v1alpha.ApiDiscoveryObservation.CreateObservationJob
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • apim.observationJobs.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.apim.v1alpha.ApiDiscoveryObservation.CreateObservationJob"

CreateObservationSource

  • Método: google.cloud.apim.v1alpha.ApiDiscoveryObservation.CreateObservationSource
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • apim.observationSources.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.apim.v1alpha.ApiDiscoveryObservation.CreateObservationSource"

DeleteObservationJob

  • Método: google.cloud.apim.v1alpha.ApiDiscoveryObservation.DeleteObservationJob
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • apim.observationJobs.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.apim.v1alpha.ApiDiscoveryObservation.DeleteObservationJob"

DeleteObservationSource

  • Método: google.cloud.apim.v1alpha.ApiDiscoveryObservation.DeleteObservationSource
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • apim.observationSources.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.apim.v1alpha.ApiDiscoveryObservation.DeleteObservationSource"

DisableObservationJob

  • Método: google.cloud.apim.v1alpha.ApiDiscoveryObservation.DisableObservationJob
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • apim.observationJobs.disable - 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.apim.v1alpha.ApiDiscoveryObservation.DisableObservationJob"

EnableObservationJob

  • Método: google.cloud.apim.v1alpha.ApiDiscoveryObservation.EnableObservationJob
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • apim.observationJobs.enable - 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.apim.v1alpha.ApiDiscoveryObservation.EnableObservationJob"

GetApiObservation

  • Método: google.cloud.apim.v1alpha.ApiDiscoveryObservation.GetApiObservation
  • Tipo de registro de auditoria: acesso a dados
  • Permissões:
    • apim.apiObservations.get - DATA_READ
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.GetApiObservation"

GetObservationJob

  • Método: google.cloud.apim.v1alpha.ApiDiscoveryObservation.GetObservationJob
  • Tipo de registro de auditoria: acesso a dados
  • Permissões:
    • apim.observationJobs.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.apim.v1alpha.ApiDiscoveryObservation.GetObservationJob"

ListApiObservationTags

  • Método: google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListApiObservationTags
  • Tipo de registro de auditoria: acesso a dados
  • Permissões:
    • apim.locations.listApiObservationTags - 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.apim.v1alpha.ApiDiscoveryObservation.ListApiObservationTags"

ListApiObservations

  • Método: google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListApiObservations
  • Tipo de registro de auditoria: acesso a dados
  • Permissões:
    • apim.apiObservations.list - DATA_READ
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListApiObservations"

ListApiOperations

  • Método: google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListApiOperations
  • Tipo de registro de auditoria: acesso a dados
  • Permissões:
    • apim.apiOperations.list - DATA_READ
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListApiOperations"

ListObservationJobs

  • Método: google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListObservationJobs
  • Tipo de registro de auditoria: acesso a dados
  • Permissões:
    • apim.observationJobs.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.apim.v1alpha.ApiDiscoveryObservation.ListObservationJobs"

ListObservationSources

  • Método: google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListObservationSources
  • Tipo de registro de auditoria: acesso a dados
  • Permissões:
    • apim.observationSources.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.apim.v1alpha.ApiDiscoveryObservation.ListObservationSources"

Métodos que não produzem registros de auditoria

Um método pode não produzir registros de auditoria para um ou mais dos seguintes itens motivos:

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

Os métodos a seguir não produzem registros de auditoria:

  • google.cloud.location.Locations.GetLocation
  • google.cloud.location.Locations.ListLocations
  • google.longrunning.Operations.CancelOperation
  • google.longrunning.Operations.DeleteOperation
  • google.longrunning.Operations.GetOperation
  • google.longrunning.Operations.ListOperations
  • google.longrunning.Operations.WaitOperation