管理订阅

作为 Analytics Hub 订阅者,您可以执行以下任务:

  • 订阅清单。
  • 列出给定项目中的当前订阅。
  • 删除订阅。

作为 Analytics Hub 发布方,您可以执行以下任务:

  • 查看清单的所有订阅。
  • 撤销对特定订阅的访问权限。

订阅是位于订阅者项目中的区域化资源。订阅存储有关订阅者的信息,并代表发布者和订阅者之间的合约。

准备工作

如需开始使用 BigQuery Sharing(以前称为 Analytics Hub),您需要在 Google Cloud 项目中启用 Analytics Hub API。

所需权限

要启用 Analytics Hub API,您需要以下 Identity and Access Management (IAM) 权限:

  • serviceUsage.services.get
  • serviceUsage.services.list
  • serviceUsage.services.enable

以下预定义 IAM 角色可提供启用 Analytics Hub API 所需的权限:

  • roles/serviceusage.serviceUsageAdmin

如需详细了解 BigQuery 中的 IAM 角色,请参阅预定义的角色和权限

启用 Analytics Hub API

如需启用 Analytics Hub API,请执行以下操作:

控制台

前往 Analytics Hub API 页面,然后为您的 Google Cloud 项目启用 Analytics Hub API。

启用 Analytics Hub API

gcloud

运行 gcloud services enable 命令:

gcloud services enable analyticshub.googleapis.com

所需的角色

如需获得管理订阅所需的权限,请让您的管理员为您授予项目的 Analytics Hub Subscription Owner (roles/analyticshub.subscriptionOwner) IAM 角色。 如需详细了解如何授予角色,请参阅管理对项目、文件夹和组织的访问权限

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

订阅方工作流

订阅者可以对订阅执行以下操作。

订阅清单

如需订阅清单,请按照订阅清单中的步骤操作。

列出订阅

如需查看给定项目中的当前订阅,请使用 projects.locations.subscriptions.list 方法

GET https://analyticshub.googleapis.com/v1/projects/PROJECT_ID/location/LOCATION/subscriptions

替换以下内容:

  • PROJECT_ID:包含您要列出的订阅的项目 ID。

  • LOCATION:您要列出现有订阅的位置。

删除订阅

如需删除订阅,请使用 projects.locations.subscriptions.delete 方法

DELETE https://analyticshub.googleapis.com/v1/projects/PROJECT_ID/location/LOCATION/subscriptions/SUBSCRIPTION_ID

替换以下内容:

  • PROJECT_ID:包含您要删除的订阅的项目 ID。
  • LOCATION:要删除的订阅的位置。如需详细了解支持 BigQuery 共享的位置,请参阅支持的区域
  • SUBSCRIPTION_ID:您要删除的订阅的 ID。

请求正文必须为空。如果请求成功,响应正文将包含一个操作实例。

如果订阅是由订阅者发起的,那么删除订阅会从订阅者的项目中删除关联的数据集。

从面向多个区域的清单中删除订阅(预览版)时,系统还会从订阅者的项目中删除所有主要和次要关联的数据集副本。

如需详细了解您可以使用 API 针对订阅执行的任务,请参阅 projects.locations.subscriptions 方法

发布方工作流

发布者可以对订阅执行以下操作。如需详细了解如何管理清单的订阅,请参阅管理清单

列出订阅

如需列出所有订阅,请选择以下选项之一。

控制台

  1. 在 Google Cloud 控制台中,前往 Sharing (Analytics Hub) 页面。

    前往 Sharing (Analytics Hub)

    此时会显示一个页面,其中列出了您可以访问的所有数据交换

  2. 点击要列出订阅的数据交换名称。

  3. 点击订阅标签页,以查看数据交换中清单的所有订阅。

API

如需列出特定数据交换中的清单订阅,请使用 projects.locations.dataExchanges.listSubscriptions 方法

GET https://analyticshub.googleapis.com/v1/projects/PROJECT_ID/location/LOCATION/dataExchanges/DATAEXCHANGE_ID:listSubscriptions

替换以下内容:

  • PROJECT_ID:要列出要移除的订阅的数据交换的项目 ID。
  • LOCATION:要列出订阅的数据交换的位置。
  • DATAEXCHANGE_ID:要列出订阅的数据交换的 ID。

撤消订阅

当发布方撤消订阅时,订阅者将无法查询关联的数据集。由于这是发布者针对订阅者拥有的资源发起的操作,因此关联数据集在订阅者的项目中仍处于悬空状态。订阅者可以选择删除悬空数据集来将其移除。

如果发布方撤消了对多区域列表的订阅(预览版),订阅方将无法再查询任何主要或次要关联的数据集副本。

如需撤消订阅,请选择以下选项之一:

控制台

  1. 在 Google Cloud 控制台中,前往 Sharing (Analytics Hub) 页面。

    前往 Sharing (Analytics Hub)

    此时会显示一个页面,其中列出了您可以访问的所有数据交换。

  2. 点击要在其中创建清单的数据交换名称。

  3. 点击订阅标签页,以查看数据交换的所有订阅。

  4. 选中要撤消的订阅旁边的复选框,或选择所有订阅。

  5. 点击撤消订阅

API

如需撤消订阅,请使用 projects.locations.subscriptions.revoke 方法

POST https://analyticshub.googleapis.com/v1/projects/PROJECT_ID/location/LOCATION/subscriptions/SUBSCRIPTION_ID:revoke

替换以下内容:

  • PROJECT_ID:要撤消的订阅的项目 ID。
  • LOCATION:订阅的位置。
  • SUBSCRIPTION_ID:要撤消的订阅的 ID。

限制

订阅受限于以下限制:

  • 2023 年 7 月 25 日之前创建的关联数据集不会回填。只有在 2023 年 7 月 25 日之后创建的订阅才适用 API 方法。

后续步骤