命名 Knowledge Catalog 资源的准则

A Google Cloud 资源是指您在 Google Cloud中创建或使用的任何组件。这些资源构成了在平台上运行的应用和系统的构建块。

如需详细了解常规 Google Cloud 资源命名， 请参阅资源名称。

资源命名格式

下表列出了 Knowledge Catalog 资源的完整资源名称格式：

资源 完整资源名称格式
条目组 projects/{PROJECT_ID}/locations/{LOCATION}/entryGroups/{ENTRY_GROUP_ID}
条目 projects/{PROJECT_ID}/locations/{LOCATION}/entryGroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}
条目类型 projects/{PROJECT_ID}/locations/{LOCATION}/entryTypes/{ENTRY_TYPE_ID}
切面类型 projects/{PROJECT_ID}/locations/{LOCATION}/aspectTypes/{ASPECT_TYPE_ID}
条目链接 projects/{PROJECT_ID}/locations/{LOCATION}/entryGroups/{ENTRY_GROUP_ID}/entryLinks/{ENTRY_LINK_ID}
元数据作业 projects/{PROJECT_ID}/locations/{LOCATION}/metadataJobs/{METADATA_JOB_ID}
元数据 Feed projects/{PROJECT_ID}/locations/{LOCATION}/metadataFeeds/{METADATA_FEED_ID}
术语表 projects/{PROJECT_ID}/locations/{LOCATION}/glossaries/{GLOSSARY_ID}
术语表类别 projects/{PROJECT_ID}/locations/{LOCATION}/glossaries/{GLOSSARY_ID}/categories/{GLOSSARY_CATEGORY_ID}
术语表术语 projects/{PROJECT_ID}/locations/{LOCATION}/glossaries/{GLOSSARY_ID}/terms/{GLOSSARY_TERM_ID}
数据产品 projects/{PROJECT_ID}/locations/{LOCATION}/dataProducts/{DATA_PRODUCT_ID}
数据域 projects/{PROJECT_ID}/locations/{LOCATION}/dataDomains/{DATA_DOMAIN_ID}
沿袭流程 projects/{PROJECT_ID}/locations/{LOCATION}/processes/{PROCESS_ID}
沿袭运行 projects/{PROJECT_ID}/locations/{LOCATION}/processes/{PROCESS_ID}/runs/{RUN_ID}
沿袭事件 projects/{PROJECT_ID}/locations/{LOCATION}/processes/{PROCESS_ID}/runs/{RUN_ID}/lineageEvents/{LINEAGE_EVENT_ID}

资源名称组成部分

以下部分详细介绍了每个组成部分。

项目 ID

该值必须是 项目 ID 或项目编号，可从 控制台 Google Cloud 中获取。例如，my-cool-project 是项目 ID，而 123456789123 是项目编号。

位置

该值必须是受支持的 Knowledge Catalog 位置之一。 如需查看可用位置的列表，请参阅 Knowledge Catalog 位置。

资源 ID

资源路径包含层次结构中每个资源及其父资源的唯一标识符 (ID) 段。以下部分介绍了每种资源 ID 的命名准则和格式要求。

标准资源 ID

除了 条目 ID 和 数据沿袭资源 ID 之外，所有资源 ID 变量（ 例如 {ENTRY_GROUP_ID} 和 {GLOSSARY_ID}）都必须 符合以下准则：

  • 以小写字母开头。
  • 包含 1 到 63 个字符。
  • 仅包含小写字母、数字、连字符和下划线。
  • 以数字或小写字母结尾。

系统条目组

条目 ID

{ENTRY_ID} 的命名准则有所不同：

  • 最多包含 4000 个字符。

  • 使用基于 Google Cloud 完整资源名称的条目 ID 格式。 该格式是资源的完整资源名称，不包含 API 服务名称部分中的双斜杠前缀。这样便可以使用关联的资源名称检索条目。

    例如：

    • 如果 Looker 实例的完整资源名称为 //looker.googleapis.com/projects/my-project/locations/us-central1/instances/my-instance, 则建议的 {ENTRY_ID} 为 looker.googleapis.com/projects/my-project/locations/us-central1/instances/my-instance。

数据沿袭资源 ID

数据沿袭资源表示数据转换操作的层次结构：

  • 流程 ID ({PROCESS_ID})：标识 数据转换的定义（例如特定 SQL 查询或 ETL 流水线）。
  • **运行 ID ({RUN_ID})** ：标识父流程的单个执行实例 。
  • 沿袭事件 ID ({LINEAGE_EVENT_ID})：标识在运行期间发生的来源和目标之间的离散 数据移动事件。

通过 API 创建自定义沿袭资源时，变量 {PROCESS_ID}、{RUN_ID} 和 {LINEAGE_EVENT_ID} 必须符合以下准则：

  • 最多包含 200 个字符。
  • 仅包含字母（区分大小写）、数字、连字符、下划线、冒号和英文句点。

对于自动沿袭（例如 BigQuery 查询、Managed Service for Apache Spark 或 OpenLineage 提取），Knowledge Catalog 会自动生成这些 ID。

BigQuery 条目名称

通过 Knowledge Catalog API 与 BigQuery 资源互动时，您必须使用特定格式的条目组 ID 和条目 ID。

  • 条目组 ID：@bigquery
  • 条目 ID：bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}

示例

如果您的 BigQuery 表是 projects/test-project/datasets/test_dataset/tables/test_table，则完全限定的 Knowledge Catalog 条目名称如下所示：

projects/{PROJECT_ID}/locations/{LOCATION}/entryGroups/@bigquery/entries/bigquery.googleapis.com/projects/test-project/datasets/test_dataset/tables/test_table