使用数据网域

预览

此产品或功能受服务专用条款的“通用服务条款”部分中的“正式发布前产品条款”的约束。 正式发布前产品和功能“按原样”提供，可能只能获得有限的支持。 如需了解详情，请参阅发布阶段说明。

作为数据网域用户，您可以使用数据网域将搜索结果限定为特定业务背景，搜索 BigQuery 数据集、表和数据产品，以及发现特定网域边界内的元数据。

准备工作

在按网域执行搜索之前，请确保您拥有所需的角色并已启用所需的 API。

启用 API

启用 Dataplex API（如果尚未启用）。

启用 API 所需的角色

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

启用 API

所需的角色

如需获得使用数据网域搜索和发现元数据所需的权限，请让管理员为您授予项目或数据网域的以下 IAM 角色：

• 查看网域条目的元数据以进行发现：Dataplex Data Domain Entry Reader (roles/dataplex.dataDomainEntryReader)
• 查看网域配置和绑定：Dataplex Data Domain Configuration Viewer (roles/dataplex.dataDomainViewer)

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

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

浏览网域层次结构

如需详细了解如何浏览网域层次结构，请参阅查看位置中的数据网域和子网域。

查找数据网域内的资源

如需搜索包含特定网域的资源，请按以下步骤操作：

控制台

1. 在 Google Cloud 控制台中，依次前往 Knowledge Catalog > 搜索页面。

   转到搜索

2. 点击试用自然搜索以启用自然搜索功能。

3. 点击过滤器。

4. 在范围字段中，从列表中选择网域。

5. 在选择网域字段中，选择要将结果范围缩小到的网域。根据需要添加任何其他过滤条件。

或者，您也可以使用在网域内搜索菜单选项来查找网域中的资源：

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

   前往“数据网域”

2. 从 more_vert 菜单中选择在网域内搜索。此操作会自动打开一个应用了 domain 过滤条件的搜索窗口。

3. 使用搜索字段查找网域中的资源。

REST

如需搜索限定于数据网域的条目，请使用 projects.locations.searchEntries 方法并在 contexts 参数中提供网域路径。

注意： searchEntries 路径中的位置可以是 global（对于完全扇出），也可以是特定区域，具体取决于您的搜索后端配置。

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

• PROJECT_ID：您的 Google Cloud 项目的 ID。
• LOCATION_ID：搜索查询的区域（或 global）。
• QUERY：搜索查询字符串。
• DOMAIN_ID：定义搜索范围上下文的数据网域的唯一标识符。

HTTP 方法和网址：

POST https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID:searchEntries

请求 JSON 正文：

{
  "query": "QUERY",
  "contexts": [ "projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/DOMAIN_ID" ],
  "semantic_search": true,
  "page_size": 100
}

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

curl（Linux、macOS 或 Cloud Shell）

注意：以下命令假定您已使用您的用户账号通过运行 gcloud init 或 gcloud auth login 登录 gcloud CLI，或者使用了 Cloud Shell，这会使您自动登录 gcloud CLI。您可以运行 gcloud auth list 来检查当前活跃的账号。

将请求正文保存在名为 request.json 的文件中，然后执行以下命令：

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID:searchEntries"

PowerShell (Windows)

注意：以下命令假定您已使用您的用户账号通过运行 gcloud init 或 gcloud auth login 登录 gcloud CLI。您可以运行 gcloud auth list 来检查当前活跃的账号。

将请求正文保存在名为 request.json 的文件中，然后执行以下命令：

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID:searchEntries" | Select-Object -Expand Content

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

限制

当您在网域上下文之外搜索资源时（例如使用全局搜索时），网域的可发现性权限不适用。 您只能看到您在底层系统（例如 BigQuery）中有权访问的资源。

假设某个 BigQuery 数据集包含在某个数据网域中。您拥有网域的 Dataplex Data Domain Entry Reader 角色，但没有直接在 BigQuery 中查看数据集的权限：

• 在网域内搜索：您会在搜索结果中看到相应数据集，因为网域权限适用。
• 在网域外搜索：您在搜索结果中看不到相应数据集。在常规搜索中，网域权限不适用，您也无法在 BigQuery 中直接访问。

后续步骤

• 详细了解数据网域。
• 了解如何创建数据网域。
• 了解如何管理数据网域资源。