快速入门:使用 JSON 请求

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

准备工作

  1. 登录您的 Google 帐号。

    如果您还没有 Google 帐号,请注册新帐号

  2. 在 Cloud Console 的项目选择器页面上,选择或创建 Cloud 项目。

    转到项目选择器页面

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

  4. 启用 DLP API。

    启用 API

  5. 安装并初始化 Cloud SDK

权限

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

如需在项目级层为您的用户提供 dlp.admin 角色,请执行以下操作:

网页界面

  1. 在 Google Cloud Platform Console 中打开“Cloud Identity and Access Management”页面。

    打开 IAM 页面

  2. 点击选择项目

  3. 选择您的项目,然后点击打开

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

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

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

  6. 点击添加

命令行

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

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

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

    bindings:
    - members:
    - group: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 请求包含 InspectConfigContentItem 对象。完成本快速入门后,请尝试将您自己的字符串添加到 item,并尝试修改某些 inspectConfig 字段以查看其效果。

  2. 获取授权令牌:

    gcloud auth print-access-token

  3. 使用 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 参考