快速入门:使用 JSON 请求

此页面介绍如何通过直接调用 API 在 Cloud Data Loss Prevention API 中执行基本任务。

准备工作

  1. 登录您的 Google Cloud 帐号。如果您是 Google Cloud 新手,请创建一个帐号来评估我们的产品在实际场景中的表现。新客户还可获享 $300 赠金,用于运行、测试和部署工作负载。
  2. 在 Google Cloud Console 的项目选择器页面上,选择或创建一个 Google Cloud 项目。

    转到“项目选择器”

  3. 确保您的 Cloud 项目已启用结算功能。 了解如何确认您的项目是否已启用结算功能

  4. 启用 DLP API。

    启用 API

  5. 创建服务帐号:

    1. 在 Cloud Console 中,转到创建服务帐号页面。

      转到“创建服务帐号”
    2. 选择一个项目。
    3. 服务帐号名称字段中,输入一个名称。 Cloud Console 会根据此名称填充服务帐号 ID 字段。

      服务帐号说明字段中,输入说明。例如,Service account for quickstart

    4. 点击创建并继续
    5. 点击选择角色字段。

      快速访问下,点击基本,然后点击所有者

    6. 点击继续
    7. 点击完成以完成服务帐号的创建过程。

      不要关闭浏览器窗口。您将在下一步骤中用到它。

  6. 创建服务帐号密钥:

    1. 在 Cloud Console 中,点击您创建的服务帐号的电子邮件地址。
    2. 点击密钥
    3. 依次点击添加密钥创建新密钥
    4. 点击创建。JSON 密钥文件将下载到您的计算机上。
    5. 点击关闭
  7. 将环境变量 GOOGLE_APPLICATION_CREDENTIALS 设置为包含您的服务帐号密钥的 JSON 文件的路径。 此变量仅适用于当前的 shell 会话,因此,如果您打开新的会话,请重新设置该变量。

  8. 安装并初始化 Cloud SDK

权限

检查内容需要 parent 中所指定项目的 serviceusage.services.use 权限。roles/editorroles/ownerroles.dlp.user 角色包含所需的权限,您也可以自行定义自定义角色

如需向用户授予项目级的 dlp.admin 角色,请选择以下标签页之一并完成相应步骤。

网页界面

  1. 打开 Google Cloud Console 中的 Identity and Access Management 页面。

    打开 IAM 页面

  2. 如果尚未选择项目,请点击项目选择器,然后选择您的项目。

  3. Identity and Access Management 页面上,点击添加

  4. 添加成员对话框中,执行以下操作:

    • 对于成员,请输入用户电子邮件:test@example.com
    • 对于角色,请点击选择角色,然后选择 Cloud DLP > DLP 用户

  5. 点击添加

命令行

  1. 如需向项目的 IAM 政策添加绑定,请输入以下命令,将 [PROJECT_ID] 替换为您的项目 ID。

    gcloud projects add-iam-policy-binding [PROJECT_ID] --member user:test@example.com --role roles/dlp.user

  2. 该命令将更新后的政策写入控制台窗口:

    bindings:
    - members:
    - user:test@example.com
    role: roles/dlp.user

检查字符串是否存在敏感信息

本部分介绍如何使用 projects.content.inspect REST 方法请求服务扫描示例文本。

  1. 创建包含以下文本的 JSON 请求文件,然后将其保存为 inspect-request.json

    {
      "item":{
        "value":"My phone number is (206) 555-0123."
      },
      "inspectConfig":{
        "infoTypes":[
          {
            "name":"PHONE_NUMBER"
          },
          {
            "name":"US_TOLLFREE_PHONE_NUMBER"
          }
        ],
        "minLikelihood":"POSSIBLE",
        "limits":{
          "maxFindingsPerItem":0
        },
        "includeQuote":true
      }
    }

    在该 JSON 请求中,item 字段包含一个 ContentItem 对象,而 inspectConfig 字段包含一个 InspectConfig 对象。完成本快速入门后,请尝试将您自己的字符串添加到 item,然后尝试修改某些 inspectConfig 字段以查看其效果。

  2. 激活服务帐号:

    gcloud auth activate-service-account SERVICE_ACCOUNT \
       --key-file=PATH_TO_SERVICE_ACCOUNT_KEY \
       --project=PROJECT_ID

    请替换以下内容:

    • SERVICE_ACCOUNT:您的服务帐号的 ID。
    • PATH_TO_SERVICE_ACCOUNT_KEY:包含服务帐号私钥的 JSON 文件的路径。这是您在准备工作部分中设置身份验证时下载的 JSON 文件。
    • PROJECT_ID:您设置为使用 Cloud DLP 的项目。
  3. 获取授权令牌:

    gcloud auth print-access-token

  4. 使用 curl 发出 content:inspect 请求,并向其传递您输出的访问令牌以及您在第 1 步中设置的 JSON 请求的文件名:

    curl -s \
    -H "Authorization: Bearer [ACCESS_TOKEN]" \
    -H "Content-Type: application/json" \
    https://dlp.googleapis.com/v2/projects/[PROJECT_ID]/content:inspect \
    -d @inspect-request.json
    如需将文件名传递给 curl,您可以使用 -d 选项(表示“数据”),并在文件名前面加上 @ 符号。此文件必须位于您执行 curl 命令所在的目录中。

Cloud DLP 使用以下 JSON 响应您的请求:

{
  "result":{
    "findings":[
      {
        "quote":"(206) 555-0123",
        "infoType":{
          "name":"PHONE_NUMBER"
        },
        "likelihood":"LIKELY",
        "location":{
          "byteRange":{
            "start":"19",
            "end":"33"
          },
          "codepointRange":{
            "start":"19",
            "end":"33"
          }
        },
        "createTime":"2018-11-30T01:01:30.883Z"
      }
    ]
  }
}

恭喜!您已向 Cloud DLP 发送了自己的第一个请求!

后续步骤

  • 阅读方法指南,以开始检查文本和图片中的敏感数据,并隐去文本和图片中的敏感数据。
  • 阅读概念,以更好地理解检查、遮盖、infoType 和可能性。
  • 查看 API 参考