API Gateway 稽核記錄

本文列出 API Gateway 的稽核方法。 Google Cloud 服務會產生稽核記錄，用以記錄 Google Cloud 資源中的管理和存取活動。如要進一步瞭解 Cloud 稽核記錄，請參閱以下內容：

服務名稱

如要查看 API Gateway 稽核記錄，請按照下列步驟操作：

  1. 前往 Google Cloud 控制台的「Logs Explorer」頁面：

    前往 Logs Explorer

  2. 複製下列查詢並貼到「Logs Explorer」的「Query」欄位，然後點選「Run query」。

        protoPayload.serviceName="apigateway.googleapis.com"

依權限類型區分的方法

每個 IAM 權限都具有 type 屬性，其值為以下四個列舉值之一：ADMIN_READ、ADMIN_WRITE、DATA_READ 或 DATA_WRITE。呼叫方法時，API Gateway 會產生一筆稽核記錄，類別取決於執行該方法所需權限的 type 屬性。若方法需要的 IAM 權限，type 屬性值為 DATA_READ、DATA_WRITE 或 ADMIN_READ，就會產生資料存取稽核記錄；若所需 IAM 權限的 type 屬性值為 ADMIN_WRITE，則會產生管理員活動稽核記錄。

下表列出的 API 方法中，如標有 (LRO) 字樣，表示為長時間執行的作業。這類方法通常會產生兩個稽核記錄項目，作業開始和結束時各一個。詳情請參閱「長時間執行的作業稽核記錄」。
權限類型 方法
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.ListApiConfigs
google.cloud.apigateway.v1beta.ApiGatewayService.ListApis
google.cloud.apigateway.v1beta.ApiGatewayService.ListGateways
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

API 介面稽核記錄

如要瞭解各方法所需的權限及評估方式，請參閱 API Gateway 的 Identity and Access Management 說明文件。

google.cloud.apigateway.v1.ApiGatewayService

屬於 google.cloud.apigateway.v1.ApiGatewayService 的方法會產生以下稽核記錄。

CreateApi

  • 方法：google.cloud.apigateway.v1.ApiGatewayService.CreateApi
  • 稽核記錄類型：管理員活動
  • 權限：
    • apigateway.apis.create - ADMIN_WRITE
  • 方法的作業種類： 長時間執行的作業
  • 篩選條件： protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.CreateApi"

CreateApiConfig

  • 方法：google.cloud.apigateway.v1.ApiGatewayService.CreateApiConfig
  • 稽核記錄類型：管理員活動
  • 權限：
    • apigateway.apiconfigs.create - ADMIN_WRITE
  • 方法的作業種類： 長時間執行的作業
  • 篩選條件： protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.CreateApiConfig"

CreateGateway

  • 方法：google.cloud.apigateway.v1.ApiGatewayService.CreateGateway
  • 稽核記錄類型：管理員活動
  • 權限：
    • apigateway.gateways.create - ADMIN_WRITE
  • 方法的作業種類： 長時間執行的作業
  • 篩選條件： protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.CreateGateway"

DeleteApi

  • 方法：google.cloud.apigateway.v1.ApiGatewayService.DeleteApi
  • 稽核記錄類型：管理員活動
  • 權限：
    • apigateway.apis.delete - ADMIN_WRITE
  • 方法的作業種類： 長時間執行的作業
  • 篩選條件： protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.DeleteApi"

DeleteApiConfig

  • 方法：google.cloud.apigateway.v1.ApiGatewayService.DeleteApiConfig
  • 稽核記錄類型：管理員活動
  • 權限：
    • apigateway.apiconfigs.delete - ADMIN_WRITE
  • 方法的作業種類： 長時間執行的作業
  • 篩選條件： protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.DeleteApiConfig"

DeleteGateway

  • 方法：google.cloud.apigateway.v1.ApiGatewayService.DeleteGateway
  • 稽核記錄類型：管理員活動
  • 權限：
    • apigateway.gateways.delete - ADMIN_WRITE
  • 方法的作業種類： 長時間執行的作業
  • 篩選條件： protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.DeleteGateway"

GetApi

  • 方法：google.cloud.apigateway.v1.ApiGatewayService.GetApi
  • 稽核記錄類型：資料存取
  • 權限：
    • apigateway.apis.get - ADMIN_READ
  • 方法的作業種類： 非長時間執行或串流作業。
  • 篩選條件： protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.GetApi"

GetApiConfig

  • 方法：google.cloud.apigateway.v1.ApiGatewayService.GetApiConfig
  • 稽核記錄類型：資料存取
  • 權限：
    • apigateway.apiconfigs.get - ADMIN_READ
  • 方法的作業種類： 非長時間執行或串流作業。
  • 篩選條件： protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.GetApiConfig"

GetGateway

  • 方法：google.cloud.apigateway.v1.ApiGatewayService.GetGateway
  • 稽核記錄類型：資料存取
  • 權限：
    • apigateway.gateways.get - ADMIN_READ
  • 方法的作業種類： 非長時間執行或串流作業。
  • 篩選條件： protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.GetGateway"

ListApiConfigs

  • 方法：google.cloud.apigateway.v1.ApiGatewayService.ListApiConfigs
  • 稽核記錄類型：資料存取
  • 權限：
    • apigateway.apiconfigs.list - ADMIN_READ
  • 方法的作業種類： 非長時間執行或串流作業。
  • 篩選條件： protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.ListApiConfigs"

ListApis

  • 方法：google.cloud.apigateway.v1.ApiGatewayService.ListApis
  • 稽核記錄類型：資料存取
  • 權限：
    • apigateway.apis.list - ADMIN_READ
  • 方法的作業種類： 非長時間執行或串流作業。
  • 篩選條件： protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.ListApis"

ListGateways

  • 方法：google.cloud.apigateway.v1.ApiGatewayService.ListGateways
  • 稽核記錄類型：資料存取
  • 權限：
    • apigateway.gateways.list - ADMIN_READ
  • 方法的作業種類： 非長時間執行或串流作業。
  • 篩選條件： protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.ListGateways"

UpdateApi

  • 方法：google.cloud.apigateway.v1.ApiGatewayService.UpdateApi
  • 稽核記錄類型：管理員活動
  • 權限：
    • apigateway.apis.update - ADMIN_WRITE
  • 方法的作業種類： 長時間執行的作業
  • 篩選條件： protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.UpdateApi"

UpdateApiConfig

  • 方法：google.cloud.apigateway.v1.ApiGatewayService.UpdateApiConfig
  • 稽核記錄類型：管理員活動
  • 權限：
    • apigateway.apiconfigs.update - ADMIN_WRITE
  • 方法的作業種類： 長時間執行的作業
  • 篩選條件： protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.UpdateApiConfig"

UpdateGateway

  • 方法：google.cloud.apigateway.v1.ApiGatewayService.UpdateGateway
  • 稽核記錄類型：管理員活動
  • 權限：
    • apigateway.gateways.update - ADMIN_WRITE
  • 方法的作業種類： 長時間執行的作業
  • 篩選條件： protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.UpdateGateway"

google.cloud.apigateway.v1beta.ApiGatewayService

屬於 google.cloud.apigateway.v1beta.ApiGatewayService 的方法會產生以下稽核記錄。

CreateApi

  • 方法：google.cloud.apigateway.v1beta.ApiGatewayService.CreateApi
  • 稽核記錄類型：管理員活動
  • 權限：
    • apigateway.apis.create - ADMIN_WRITE
  • 方法的作業種類： 長時間執行的作業
  • 篩選條件： protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.CreateApi"

CreateApiConfig

  • 方法：google.cloud.apigateway.v1beta.ApiGatewayService.CreateApiConfig
  • 稽核記錄類型：管理員活動
  • 權限：
    • apigateway.apiconfigs.create - ADMIN_WRITE
  • 方法的作業種類： 長時間執行的作業
  • 篩選條件： protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.CreateApiConfig"

CreateGateway

  • 方法：google.cloud.apigateway.v1beta.ApiGatewayService.CreateGateway
  • 稽核記錄類型：管理員活動
  • 權限：
    • apigateway.gateways.create - ADMIN_WRITE
  • 方法的作業種類： 長時間執行的作業
  • 篩選條件： protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.CreateGateway"

DeleteApi

  • 方法：google.cloud.apigateway.v1beta.ApiGatewayService.DeleteApi
  • 稽核記錄類型：管理員活動
  • 權限：
    • apigateway.apis.delete - ADMIN_WRITE
  • 方法的作業種類： 長時間執行的作業
  • 篩選條件： protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.DeleteApi"

DeleteApiConfig

  • 方法：google.cloud.apigateway.v1beta.ApiGatewayService.DeleteApiConfig
  • 稽核記錄類型：管理員活動
  • 權限：
    • apigateway.apiconfigs.delete - ADMIN_WRITE
  • 方法的作業種類： 長時間執行的作業
  • 篩選條件： protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.DeleteApiConfig"

DeleteGateway

  • 方法：google.cloud.apigateway.v1beta.ApiGatewayService.DeleteGateway
  • 稽核記錄類型：管理員活動
  • 權限：
    • apigateway.gateways.delete - ADMIN_WRITE
  • 方法的作業種類： 長時間執行的作業
  • 篩選條件： protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.DeleteGateway"

GetApi

  • 方法：google.cloud.apigateway.v1beta.ApiGatewayService.GetApi
  • 稽核記錄類型：資料存取
  • 權限：
    • apigateway.apis.get - ADMIN_READ
  • 方法的作業種類： 非長時間執行或串流作業。
  • 篩選條件： protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.GetApi"

GetApiConfig

  • 方法：google.cloud.apigateway.v1beta.ApiGatewayService.GetApiConfig
  • 稽核記錄類型：資料存取
  • 權限：
    • apigateway.apiconfigs.get - ADMIN_READ
  • 方法的作業種類： 非長時間執行或串流作業。
  • 篩選條件： protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.GetApiConfig"

GetGateway

  • 方法：google.cloud.apigateway.v1beta.ApiGatewayService.GetGateway
  • 稽核記錄類型：資料存取
  • 權限：
    • apigateway.gateways.get - ADMIN_READ
  • 方法的作業種類： 非長時間執行或串流作業。
  • 篩選條件： protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.GetGateway"

ListApiConfigs

  • 方法：google.cloud.apigateway.v1beta.ApiGatewayService.ListApiConfigs
  • 稽核記錄類型：資料存取
  • 權限：
    • apigateway.apiconfigs.list - ADMIN_READ
  • 方法的作業種類： 非長時間執行或串流作業。
  • 篩選條件： protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.ListApiConfigs"

ListApis

  • 方法：google.cloud.apigateway.v1beta.ApiGatewayService.ListApis
  • 稽核記錄類型：資料存取
  • 權限：
    • apigateway.apis.list - ADMIN_READ
  • 方法的作業種類： 非長時間執行或串流作業。
  • 篩選條件： protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.ListApis"

ListGateways

  • 方法：google.cloud.apigateway.v1beta.ApiGatewayService.ListGateways
  • 稽核記錄類型：資料存取
  • 權限：
    • apigateway.gateways.list - ADMIN_READ
  • 方法的作業種類： 非長時間執行或串流作業。
  • 篩選條件： protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.ListGateways"

UpdateApi

  • 方法：google.cloud.apigateway.v1beta.ApiGatewayService.UpdateApi
  • 稽核記錄類型：管理員活動
  • 權限：
    • apigateway.apis.update - ADMIN_WRITE
  • 方法的作業種類： 長時間執行的作業
  • 篩選條件： protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.UpdateApi"

UpdateApiConfig

  • 方法：google.cloud.apigateway.v1beta.ApiGatewayService.UpdateApiConfig
  • 稽核記錄類型：管理員活動
  • 權限：
    • apigateway.apiconfigs.update - ADMIN_WRITE
  • 方法的作業種類： 長時間執行的作業
  • 篩選條件： protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.UpdateApiConfig"

UpdateGateway

  • 方法：google.cloud.apigateway.v1beta.ApiGatewayService.UpdateGateway
  • 稽核記錄類型：管理員活動
  • 權限：
    • apigateway.gateways.update - ADMIN_WRITE
  • 方法的作業種類： 長時間執行的作業
  • 篩選條件： protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.UpdateGateway"

google.iam.v1.IAMPolicy

屬於 google.iam.v1.IAMPolicy 的方法會產生以下稽核記錄。

GetIamPolicy

  • 方法：GetIamPolicy
  • 稽核記錄類型：資料存取
  • 權限：
    • apigateway.apis.getIamPolicy - ADMIN_READ
    • apigateway.gateways.getIamPolicy - ADMIN_READ
  • 方法的作業種類： 非長時間執行或串流作業。
  • 篩選條件： protoPayload.methodName="GetIamPolicy"

SetIamPolicy

  • 方法：SetIamPolicy
  • 稽核記錄類型：管理員活動
  • 權限：
    • apigateway.apiconfigs.setIamPolicy - ADMIN_WRITE
    • apigateway.apis.setIamPolicy - ADMIN_WRITE
    • apigateway.gateways.setIamPolicy - ADMIN_WRITE
  • 方法的作業種類： 非長時間執行或串流作業。
  • 篩選條件： protoPayload.methodName="SetIamPolicy"

google.longrunning.Operations

屬於 google.longrunning.Operations 的方法會產生以下稽核記錄。

CancelOperation

  • 方法：google.longrunning.Operations.CancelOperation
  • 稽核記錄類型：管理員活動
  • 權限：
    • apigateway.operations.cancel - ADMIN_WRITE
  • 方法的作業種類： 非長時間執行或串流作業。
  • 篩選條件： protoPayload.methodName="google.longrunning.Operations.CancelOperation"

DeleteOperation

  • 方法：google.longrunning.Operations.DeleteOperation
  • 稽核記錄類型：管理員活動
  • 權限：
    • apigateway.operations.delete - ADMIN_WRITE
  • 方法的作業種類： 非長時間執行或串流作業。
  • 篩選條件： protoPayload.methodName="google.longrunning.Operations.DeleteOperation"

GetOperation

  • 方法：google.longrunning.Operations.GetOperation
  • 稽核記錄類型：資料存取
  • 權限：
    • apigateway.operations.get - ADMIN_READ
  • 方法的作業種類： 非長時間執行或串流作業。
  • 篩選條件： protoPayload.methodName="google.longrunning.Operations.GetOperation"

ListOperations

  • 方法：google.longrunning.Operations.ListOperations
  • 稽核記錄類型：資料存取
  • 權限：
    • apigateway.operations.list - ADMIN_READ
  • 方法的作業種類： 非長時間執行或串流作業。
  • 篩選條件： protoPayload.methodName="google.longrunning.Operations.ListOperations"

不會產生稽核記錄的方法

某些方法可能不會產生稽核記錄，原因包括以下一或多項：

  • 該方法的流量使用量高，若產生稽核記錄，會導致記錄與儲存成本過高。
  • 稽核價值低。
  • 其他稽核記錄或平台記錄已涵蓋該方法的活動。

下列方法不會產生稽核記錄：

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