管理数据网域

本文档介绍了如何使用 Google Cloud 控制台和 REST API 查看、更新和删除数据网域和子网域。

准备工作

在管理数据网域之前,请确保您拥有所需的角色并已启用所需的 API。

启用 API

启用 Dataplex API。

启用 API 所需的角色

如需启用 API,您需要拥有 serviceusage.services.enable 权限。如果您创建了项目,则可能已经通过 Owner 角色 (roles/owner) 获得了此权限。否则,您可以通过 Service Usage Admin 角色 (roles/serviceusage.serviceUsageAdmin) 获得此权限。了解如何授予角色

启用 API

所需的角色

如需获得管理数据网域所需的权限,请让管理员向您授予项目的以下 IAM 角色:

如需详细了解如何授予角色,请参阅管理对项目、文件夹和组织的访问权限

您也可以通过自定义角色或其他预定义角色来获取所需的权限。

查看数据网域和子网域

查看特定项目中的数据网域和子网域。

控制台

查看所有数据网域

  1. 在 Google Cloud 控制台中,前往数据网域页面。

    前往“数据网域”

  2. 该表格会列出已创建的网域。点击数据网域名称旁边的 展开箭头,即可查看嵌套的子网域。

查看数据网域和子网域详情

  1. 在 Google Cloud 控制台中,前往数据网域页面。

    前往“数据网域”

  2. 点击要查看的网域或子网域的名称。

  3. 网域详情页面会显示以下标签页:

    • 概览:提供网域的概览以及必需切面和可选切面的列表。
    • 资源:列出此网域中包含的资源。该列表仅显示直接包含在该网域中的文件夹、项目和资源。

REST

查看数据网域和子网域

如需查看数据网域,请使用 projects.locations.dataDomains.list 方法:

在使用任何请求数据之前,请先进行以下替换:

  • PROJECT_ID:您的 Google Cloud 项目的 ID。
  • LOCATION_ID:项目的区域。例如 us-central1

HTTP 方法和网址:

GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains

如需发送您的请求,请展开以下选项之一:

您应该会收到一个成功的状态代码 (2xx) 和一个空响应。

查看数据子网域

如需查看数据子网域,请使用 projects.locations.dataDomains.listSubdomains 方法:

在使用任何请求数据之前,请先进行以下替换:

  • PROJECT_ID:您的 Google Cloud 项目的 ID。
  • LOCATION_ID:父数据网域所在的区域。例如 us-central1
  • DOMAIN_ID:父数据网域的唯一标识符。

HTTP 方法和网址:

GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/DOMAIN_ID/subdomains

如需发送您的请求,请展开以下选项之一:

您应该会收到一个成功的状态代码 (2xx) 和一个空响应。

使用 filter 参数列出属于特定父网域的子网域:

在使用任何请求数据之前,请先进行以下替换:

  • PROJECT_ID:您的 Google Cloud 项目的 ID。
  • LOCATION_ID:父数据网域所在的区域。例如 us-central1
  • PARENT_DOMAIN_ID:父数据网域的唯一标识符。

HTTP 方法和网址:

GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains?filter=parent_data_domain="projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/PARENT_DOMAIN_ID"

如需发送您的请求,请展开以下选项之一:

您应该会收到一个成功的状态代码 (2xx) 和一个空响应。

查看数据网域详情

如需获取网域或子网域的详细信息,请使用 projects.locations.dataDomains.get 方法:

在使用任何请求数据之前,请先进行以下替换:

  • PROJECT_ID:您的 Google Cloud 项目的 ID。
  • LOCATION_ID:数据网域所在的区域。例如 us-central1
  • DOMAIN_ID:数据网域或子网域的唯一标识符。

HTTP 方法和网址:

GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/DOMAIN_ID

如需发送您的请求,请展开以下选项之一:

您应该会收到一个成功的状态代码 (2xx) 和一个空响应。

更新数据网域或子网域

您可以更新网域的显示名称、说明和标签。创建网域后,您无法更改网域 ID 或位置。

控制台

  1. 在 Google Cloud 控制台中,前往数据网域页面。

    前往“数据网域”

  2. 点击域名或子域名名称以前往详情页面。

  3. 在顶部栏中,点击修改

  4. 更新显示名称说明

  5. 点击保存

REST

如需更新数据网域,请使用 projects.locations.dataDomains.patch 方法:

在使用任何请求数据之前,请先进行以下替换:

  • PROJECT_ID:您的 Google Cloud 项目的 ID。
  • LOCATION_ID:数据网域所在的区域。例如 us-central1
  • DOMAIN_ID:数据网域或子网域的唯一标识符。

HTTP 方法和网址:

PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/DOMAIN_ID?updateMask=description,labels

请求 JSON 正文:

{
  "description": "Updated description for the domain",
  "labels": {
    "status": "active"
  }
}

如需发送您的请求,请展开以下选项之一:

您应该会收到一个成功的状态代码 (2xx) 和一个空响应。

删除数据网域或子网域

您只能删除空数据网域。您必须先删除所有子网域并移除与网域关联的所有资源绑定,然后才能尝试删除网域本身。如果网域不为空,删除请求会失败并显示错误。

控制台

  1. 在 Google Cloud 控制台中,前往数据网域页面。

    前往“数据网域”

  2. 点击域名或子域名名称以前往详情页面。

  3. 在顶部栏中,点击删除

  4. 输入数据网域或子网域名称,以确认删除。

  5. 点击删除

REST

如需删除数据网域,请使用 projects.locations.dataDomains.delete 方法:

在使用任何请求数据之前,请先进行以下替换:

  • PROJECT_ID:您的 Google Cloud 项目的 ID。
  • LOCATION_ID:数据网域所在的区域。例如 us-central1
  • DOMAIN_ID:数据网域或子网域的唯一标识符。

HTTP 方法和网址:

DELETE https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/DOMAIN_ID

如需发送您的请求,请展开以下选项之一:

您应该会收到一个成功的状态代码 (2xx) 和一个空响应。

后续步骤