启用数据访问审核日志

本指南介绍了如何使用 Google Cloud 控制台或 API 在 Google Cloud 项目、结算账号、文件夹和组织中启用或停用部分或全部数据访问审核日志。

准备工作

在继续配置数据访问审核日志之前，请先了解以下信息：

• 数据访问审核日志（BigQuery 除外）默认处于停用状态。如果您想针对 BigQuery 以外的 Google Cloud 服务写入数据访问审核日志，则必须明确启用这些日志。

• 除非您将数据访问审核日志路由到其他位置，否则这些日志会存储在 _Default 存储桶中。如需了解详情，请参阅存储和路由审核日志。

• 数据访问审核日志可帮助 Google 支持团队排查您的账号问题。因此，我们建议您尽可能启用数据访问审核日志。

配置概览

您可以配置为 Google Cloud 资源和服务启用数据访问审核日志的方式：

• 组织：您可以在组织中启用和配置数据访问审核日志，这适用于组织中所有现有的及新的 Google Cloud 项目和文件夹。

• 文件夹：您可以在文件夹中启用和配置数据访问审核日志，这适用于文件夹中所有现有的及新的 Google Cloud 项目。您无法停用已在项目的父组织中启用的数据访问审核日志。

• 项目：您可以为单个 Google Cloud 项目配置数据访问审核日志。您无法停用已在父级组织或文件夹中启用的数据访问审核日志。

• 结算账号：如需为结算账号配置数据访问审核日志，请使用 Google Cloud CLI。如需详细了解如何将 gcloud CLI 与数据访问审核日志和结算账号搭配使用，请参阅 gcloud beta billing accounts set-iam-policy 文档。

• 默认配置：您可以在组织、文件夹或 Google Cloud 项目中指定默认数据访问审核日志配置，该配置适用于将开始生成数据访问审核日志的未来 Google Cloud 服务。如需了解相关说明，请参阅设置默认配置。

• 权限类型：您可以指定仅检查特定类型权限的 Google Cloud API 发出审核日志。如需了解详情，请参阅本页的权限类型部分。

• 豁免的主账号：您可以豁免特定主账号，这样系统就不会记录其数据访问。例如，您可以豁免内部测试账号，让系统不再记录这些账号的 Cloud Monitoring 操作。如需查看有效的主账号（包括用户和群组）的列表，请参阅 Binding 类型参考文档。

您可以通过 Google Cloud 控制台的 IAM 审核日志页面或使用 API 来配置数据访问审核日志。以下部分对这些方法进行了说明。

权限类型

API 方法会检查 IAM 权限。每个 IAM 权限都有一个权限类型，该类型由 type 属性定义。权限类型分为数据访问权限类型或管理员活动权限类型：

• 数据访问权限类型：

  • ADMIN_READ：系统会检查读取元数据或配置信息的 Google Cloud API 方法是否具有此类 IAM 权限。通常，ADMIN_READ 审核日志默认处于停用状态，必须启用。

  • DATA_READ：系统会检查读取用户提供的数据的 Google Cloud API 方法是否具有此类 IAM 权限。通常，DATA_READ 审核日志默认处于停用状态，必须启用。

  • DATA_WRITE：系统会检查写入用户提供的数据的 Google Cloud API 方法是否具有此类 IAM 权限。通常，DATA_WRITE 审核日志默认处于停用状态，必须启用。

• “管理员活动”权限类型：

  • ADMIN_WRITE：系统会检查写入元数据或配置信息的 Google Cloud API 方法是否具有此类 IAM 权限。与此类型关联的审核日志（管理员活动审核日志）默认处于开启状态，且无法停用。

您可以使用 Google Cloud 控制台或调用 API 为服务启用或停用权限类型。

大多数 Google Cloud API 只会检查调用者是否具有单个 IAM 权限。如果正在调用 API 的服务启用了与该权限关联的权限类型，则该 API 会生成审核日志。

以下部分概要介绍了 Google Cloud API 方法检查 IAM 权限的其他方法。如需了解哪些方法会针对哪些权限类型进行检查，请参阅相应服务的审核日志记录文档。

针对数据访问权限类型的 IAM 权限检查

某些 Google Cloud API 方法会检查调用者是否具有具有不同数据访问权限类型的多个 IAM 权限。当项目启用其中一种数据访问权限类型时，系统会写入审核日志。

例如，API 方法可能会检查发出 API 请求的正文是否具有 example.resource.get (DATA_READ) 和 example.resource.write (DATA_WRITE) 权限。项目只需启用 DATA_WRITE 或 DATA_READ，即可让服务在发出调用时发出审核日志。

检查了“管理员活动”和“数据访问”IAM 权限类型

某些 Google Cloud API 方法会同时检查具有 ADMIN_WRITE 权限类型的 IAM 权限，以及具有数据访问权限类型的一个或多个权限。

这类 API 调用会生成管理员活动审核日志，该日志默认处于开启状态，且无法停用。

API 方法会检查服务不拥有的 IAM 权限

某些 Google Cloud 服务的 API 方法只有在为其他服务启用特定权限类型后，才会生成审核日志。

例如，Cloud Billing 有一个 API 方法，用于检查 Resource Manager 拥有的 ADMIN_READ 权限类型。必须为服务 cloudresourcemanager.googleapis.com 启用 ADMIN_READ，才能启用与 Cloud Billing API 关联的审核日志。

同一 API 方法检查不同的 IAM 权限

对于某些 Google Cloud API，方法的调用方式决定了必须在项目上启用哪些 IAM 权限类型才能生成审核日志。

例如，Spanner 有一个 API 方法，有时会检查类型为 DATA_WRITE 的 IAM 权限，有时会检查类型为 DATA_READ 的 IAM 权限，具体取决于该方法的调用方式。在这种情况下，在 API 调用的项目上为 Spanner 启用 DATA_WRITE 仅会在检查类型为 DATA_WRITE 的 IAM 权限时启用与 API 关联的审核日志。

服务专属配置

如果同时存在适合所有 Google Cloud 服务 (allServices) 的配置和适合特定 Google Cloud 服务的配置，则最终的服务配置将是这两种配置的并集。换句话说：

• 您可为特定 Google Cloud 服务启用数据访问审核日志，但无法为已在适用范围更广的配置中启用该功能的 Google Cloud 服务停用数据访问审核日志。

• 您可为 Google Cloud 服务的数据访问审核日志添加额外信息类型，但无法移除已在适用范围更广的配置中指定的信息类型。

• 您可以将主账号添加到豁免列表，但无法从适用范围更广的配置中的豁免列表中移除主账号。

• 对于 BigQuery Data Transfer Service，数据访问审核日志配置会继承自您的默认审核日志配置。

Google Cloud 资源配置

您可以为 Google Cloud 项目、结算账号、文件夹和组织配置数据访问审核日志。如果 Google Cloud 服务的配置跨层次结构，则最终的配置就是各层次结构配置的并集。换句话说，在 Google Cloud 项目级层：

• 您可以为 Google Cloud 服务启用日志，但无法为已在父级组织或文件夹中启用日志的 Google Cloud 服务停用日志。

• 您可以启用各种信息，但无法停用在父级组织或文件夹中启用的信息类型。

• 您可以将主账号添加到豁免列表，但无法将其从父级组织或文件夹的豁免列表中移除。

• 在父级组织或文件夹级层，您可以为该组织或文件夹内的 Google Cloud 项目启用数据访问审核日志，即使在该 Google Cloud 项目中并未配置数据访问审核日志也可如此。

访问权限控制

Identity and Access Management 角色和权限管理对 Logging 数据的访问权限，包括查看和管理底层数据访问审核日志配置的 IAM 政策。

如需查看或设置与数据访问配置关联的政策，您需要拥有在适当资源级层具有权限的角色。如需了解如何授予这些资源级角色，请参阅管理对 Google Cloud 项目、文件夹和组织的访问权限。

• 如需设置 IAM 政策，您需要拥有具有 resourcemanager.RESOURCE_TYPE.setIamPolicy 权限的角色。

• 如需查看 IAM 政策，您需要拥有具有 resourcemanager.RESOURCE_TYPE.getIamPolicy 权限的角色。

如需查看查看数据访问审核日志所需的权限和角色列表，请参阅使用 IAM 进行访问权限控制。

使用 Google Cloud 控制台配置数据访问审核日志

本部分介绍了如何使用 Google Cloud 控制台来配置数据访问审核日志。

您还可以使用 API 或 Google Cloud CLI 以编程方式执行这些任务；如需了解详情，请参阅使用 API 配置数据访问审核日志。

如需在 Google Cloud 控制台中访问审核日志配置选项，请按以下步骤操作：

1. 在 Google Cloud 控制台中，前往审核日志页面：

   前往审核日志

   如果您使用搜索栏查找此页面，请选择子标题为 IAM 和管理的结果。

2. 选择现有的 Google Cloud 项目、文件夹或组织。

启用审核日志

如需启用数据访问审核日志，请执行以下操作：

1. 在数据访问审核日志配置表中，从服务列中选择一项或多项 Google Cloud 服务。

2. 在日志类型标签页中，选择要为所选服务启用的数据访问审核日志类型。

3. 点击保存。

如果您已成功启用审核日志，表中会包含一个 check_circle Check 图标。

在以下示例中，您可以看到“访问权限审批”服务的数据读取审核日志类型已启用：

您还可以为生成数据访问审核日志的所有 Google Cloud 服务启用审核日志。在数据访问审核日志配置表中，选择所有 Google Cloud 服务。

请注意，这种批量配置方法仅适用于您的资源可用的 Google Cloud 服务。如果添加了新的 Google Cloud 服务，则该服务将沿用您的默认审核配置。

停用数据访问审核日志

如需停用数据访问审核日志，请执行以下操作：

1. 在数据访问审核日志配置表中，选择一项或多项 Google Cloud 服务。

2. 在信息面板的日志类型标签页中，选择要为所选服务停用的数据访问审核日志类型。

3. 点击保存。

如果您已成功停用数据访问审核日志，该表中会用一条短划线表示。任何已启用的数据访问审核日志都会以 check_circle Check 图标表示。

设置豁免项

您可以设置豁免项，以便控制哪些主账号可以为特定服务生成数据访问审核日志。在您添加豁免主账号后，系统就不会为该主账号创建所选日志类型的审核日志。

如需设置豁免，请执行以下操作：

1. 在数据访问审核日志配置表中，从服务列中选择一项 Google Cloud 服务。

2. 选择信息面板中的豁免的负责人标签页。

3. 在添加豁免主账号中，输入您要豁免的主账号，以免系统为所选服务生成数据访问审核日志。

   您可以根据需要多次点击添加豁免主账号按钮，以添加多个主账号。

   如需查看有效的主账号（包括用户和群组）的列表，请参阅 Binding 类型参考文档。

4. 在已停用的日志类型中，选择要停用的数据访问审核日志类型。

5. 点击保存。

如果您已成功向服务添加豁免主账号，则数据访问审核日志配置表中的豁免主账号列下会显示一个数字。

如需从豁免列表中移除主账号，请执行以下操作：

1. 在数据访问审核日志配置表中，从服务列中选择一项 Google Cloud 服务。

2. 选择信息面板中的豁免的负责人标签页。

3. 将鼠标指针悬停在某个主账号名称上，然后选择 delete 删除。

4. 校长姓名以带删除线的文本形式显示后，点击保存。

如需修改豁免正文的信息，请执行以下操作：

1. 在数据访问审核日志配置表中，从服务列中选择一项 Google Cloud 服务。

2. 选择信息面板中的豁免的负责人标签页。

3. 找到主账号，然后依次选择“展开”图标 expand_more 展开。

4. 根据需要为该主账号选择或取消选择数据访问审核日志类型。

5. 点击保存。

设置默认配置

您可以设置一个配置，供 Google Cloud 项目、文件夹或组织中所有新的及现有的 Google Cloud 服务沿用。如果组织中的主账号开始使用新的 Google Cloud 服务，则应用此默认配置：该服务将沿用您已为其他 Google Cloud 服务设置的审核日志记录政策，从而确保捕获数据访问审核日志。

如需设置或修改默认配置，请执行以下操作：

1. 点击设置默认配置。

2. 在信息面板的日志类型标签页中，选择要启用或停用的数据访问审核日志类型。

3. 点击保存。

4. 选择信息面板中的豁免的负责人标签页。

5. 在添加豁免主账号中，输入您要豁免的主账号，以免系统为所选服务生成数据访问审核日志。

   您可以根据需要多次点击添加豁免主账号按钮，以添加多个主账号。

   如需查看有效的主账号（包括用户和群组）的列表，请参阅 Binding 类型参考文档。

6. 在已停用的日志类型中，选择要停用的数据访问审核日志类型。

7. 点击保存。

使用 API 配置数据访问审核日志

本部分介绍了如何使用 API 和 gcloud CLI 以编程方式配置数据访问审核日志。

其中许多任务也可以使用 Google Cloud 控制台执行；如需了解相关说明，请参阅本页上的使用 Google Cloud 控制台配置数据访问审核日志。

IAM 政策对象

如需使用 API 配置数据访问审核日志，您必须修改与 Google Cloud 项目、文件夹或组织关联的 IAM 政策。审核日志配置位于政策的 auditConfigs 部分：

"auditConfigs": [
  {
    object(AuditConfig)
  }
]

如需了解详情，请参阅 IAM 政策类型。

下面的部分更详细地介绍了 AuditConfig 对象。如需了解用于更改配置的 API 和 gcloud CLI 命令，请参阅标题为 getIamPolicy 和 setIamPolicy 的部分。

AuditConfig 个对象

审核日志配置包含 AuditConfig 对象列表。每个对象针对一项服务配置日志，也可以针对所有服务建立范围更广的配置。每个对象均与如下内容类似：

{
  "service": SERVICE_NAME,
  "auditLogConfigs": [
    {
      "logType": "ADMIN_READ"
      "exemptedMembers": [ PRINCIPAL,]
    },
    {
      "logType": "DATA_READ"
      "exemptedMembers": [ PRINCIPAL,]
    },
    {
      "logType": "DATA_WRITE"
      "exemptedMembers": [ PRINCIPAL,]
    },
  ]
},

SERVICE_NAME 具有值（例如 "appengine.googleapis.com"），或者是特殊值 "allServices"。如果配置未提及特定服务，则范围更广的配置将用于该服务。如果没有配置，则不会为该服务启用数据访问审核日志。 如需查看服务名称列表，请参阅日志服务。

AuditConfig 对象的 auditLogConfigs 部分是一个包含 0 到 3 个对象的列表，其中每个对象都用于配置一类审核日志信息。如果您忽略列表中的某一种类型，则不会为该服务启用该类型的日志信息。

PRINCIPAL 是不为其收集数据访问审核日志的用户。Binding 类型介绍了不同类型的主账号（包括用户和群组），但并非所有类型都可用于配置数据访问审核日志。

以下是 JSON 和 YAML 格式的审核配置示例。如果使用 Google Cloud CLI，则默认使用 YAML 格式。

"auditConfigs": [
  {
    "auditLogConfigs": [
      {
        "logType": "ADMIN_READ"
      },
      {
        "logType": "DATA_WRITE"
      },
      {
        "logType": "DATA_READ"
      }
    ],
    "service": "allServices"
  },
  {
    "auditLogConfigs": [
      {
        "exemptedMembers": [
          "499862534253-compute@developer.gserviceaccount.com"
        ],
        "logType": "ADMIN_READ"
      }
    ],
    "service": "cloudsql.googleapis.com"
  }
],

auditConfigs:
- auditLogConfigs:
  - logType: ADMIN_READ
  - logType: DATA_WRITE
  - logType: DATA_READ
  service: allServices
- auditLogConfigs:
  - exemptedMembers:
    - 499862534253-compute@developer.gserviceaccount.com
    logType: ADMIN_READ
  service: cloudsql.googleapis.com

常见配置

以下是 Google Cloud 项目的一些常见审核日志配置。

启用所有数据访问审核日志

以下 auditConfigs 部分用于为所有服务和正文启用数据访问审核日志：

"auditConfigs": [
      {
        "service": "allServices",
        "auditLogConfigs": [
          { "logType": "ADMIN_READ" },
          { "logType": "DATA_READ"  },
          { "logType": "DATA_WRITE" },
        ]
      },
    ]

auditConfigs:
- auditLogConfigs:
  - logType: ADMIN_READ
  - logType: DATA_WRITE
  - logType: DATA_READ
  service: allServices

启用一项服务和一种信息类型

以下配置用于为 Cloud SQL 启用 DATA_WRITE 数据访问审核日志：

"auditConfigs": [
  {
    "service": "cloudsql.googleapis.com",
    "auditLogConfigs": [
      { "logType": "DATA_WRITE" },
    ]
  },
]

auditConfigs:
- auditLogConfigs:
  - logType: DATA_WRITE
  service: cloudsql.googleapis.com

停用所有数据访问审核日志

如需停用 Google Cloud 项目中的所有数据访问审核日志（BigQuery 除外），请将新 IAM 政策中的 auditConfigs: 部分留空：

"auditConfigs": [],

auditConfigs:

如果您从新政策中彻底移除 auditConfigs 部分，则 setIamPolicy 不会更改现有数据访问审核日志配置。如需了解详情，请参阅标题为 setIamPolicy 更新掩码的部分。

BigQuery 数据访问审核日志无法停用。

“getIamPolicy”和“setIamPolicy”

您可以使用 Cloud Resource Manager API getIamPolicy 和 setIamPolicy 方法来读取和写入 IAM 政策。我们提供多种特定方法供您选择：

• Cloud Resource Manager API 提供以下方法：

  projects.getIamPolicy
  projects.setIamPolicy
  organizations.getIamPolicy
  organizations.setIamPolicy
  

• Google Cloud CLI 提供以下 Resource Manager 命令：

  gcloud projects get-iam-policy
  gcloud projects set-iam-policy
  gcloud resource-manager folders get-iam-policy
  gcloud resource-manager folders set-iam-policy
  gcloud organizations get-iam-policy
  gcloud organizations set-iam-policy
  gcloud beta billing accounts get-iam-policy
  gcloud beta billing accounts set-iam-policy
  

无论您选择哪种方法，都请按以下三个步骤操作：

1. 使用一种 getIamPolicy 方法来读取当前政策。将政策保存为临时文件。
2. 修改临时文件中的政策。仅更改（或添加）auditConfigs 部分。
3. 使用一种 setIamPolicy 方法将已修改的政策写入临时文件。

如果 Resource Manager 检测到在您执行第一步中的读取操作后其他人更改了政策，则 setIamPolicy 将会失败。如果发生这种情况，请重复上述三个步骤。

示例

以下各个示例演示了如何使用 gcloud 命令和 Cloud Resource Manager API 来配置项目的数据访问审核日志。

如需配置组织数据访问审核日志，请将命令和 API 方法的“项目”版本替换为“组织”版本。

gcloud projects get-iam-policy PROJECT_ID --format=json >/tmp/policy.json
gcloud projects set-iam-policy PROJECT_ID /tmp/policy.json

setIamPolicy 更新掩码

本部分介绍了 setIamPolicy 方法中的 updateMask 参数的重要性，还介绍了为何必须谨慎使用 gcloud CLI set-iam-policy 命令，以免对 Google Cloud 项目或组织造成意外损害。

setIamPolicy API 方法使用 updateMask 参数来控制将更新哪些政策字段。例如，如果掩码不包含 bindings，那么您就不会意外更改政策的该部分。另一方面，如果掩码包含 bindings，则该部分始终都会更新。如果您未为 bindings 添加更新的值，则该部分会从政策中完全移除。

gcloud projects set-iam-policy 命令（调用 setIamPolicy）不允许您指定 updateMask 参数。取而代之的是，该命令会按以下方式计算 updateMask 的值：

• updateMask 始终包含字段 bindings 和 etag。
• 如果 set-iam-policy 中提供的政策对象包含其他任何顶级字段（例如 auditConfigs），则这些字段将添加到 updateMask 中。

由于存在上述规则，set-iam-policy 命令具有以下行为：

• 如果您在新政策中省略了 auditConfigs 部分，则 auditConfigs 部分的先前值（如果有）不会更改，因为更新掩码中不包含此部分。这一行为无害，但可能会产生混淆。

• 如果您在新政策对象中省略 bindings，则系统会从政策中移除 bindings 部分，因为更新掩码中存在此部分。这一行为危害性较大，而且可能导致所有主账号都无法访问您的 Google Cloud 项目。

• 如果您在新政策对象中省略 etag，则系统可能会停用对政策并发更改的检查，而且可能导致您的更改意外覆盖其他人的更改。