命名 Knowledge Catalog 资源的准则

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

Knowledge Catalog 中的资源包括以下内容：

  • 条目组

  • 条目

  • 条目类型

  • 切面类型

  • 条目链接

  • 元数据作业

  • 元数据 Feed

  • 术语表

  • 术语表类别

  • 术语表术语

  • 数据产品

  • 数据网域

  • 沿袭流程

  • 沿袭运行作业

  • 沿袭事件

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

资源命名格式

以下是不同资源的格式：

  • 条目组：projects/{PROJECT_ID}/locations/{LOCATION_NAME}/entryGroups/{ENTRY_GROUP_ID}

  • 条目：projects/{PROJECT_ID}/locations/{LOCATION_NAME}/entryGroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}

  • 条目类型：projects/{PROJECT_ID}/locations/{LOCATION_NAME}/entryTypes/{ENTRY_TYPE_ID}

  • 切面类型：projects/{PROJECT_ID}/locations/{LOCATION_NAME}/aspectTypes/{ASPECT_TYPE_ID}

  • 条目链接：projects/{PROJECT_ID}/locations/{LOCATION_NAME}/entryGroups/{ENTRY_GROUP_ID}/entryLinks/{ENTRY_LINK_ID}

  • 元数据作业：projects/{PROJECT_ID}/locations/{LOCATION_NAME}/metadataJobs/{METADATA_JOB_ID}

  • 元数据 Feed：projects/{PROJECT_ID}/locations/{LOCATION_NAME}/metadataFeeds/{METADATA_FEED_ID}

  • 术语表：projects/{PROJECT_ID}/locations/{LOCATION_NAME}/glossaries/{GLOSSARY_ID}

  • 术语表类别：projects/{PROJECT_ID}/locations/{LOCATION_NAME}/glossaries/{GLOSSARY_ID}/categories/{GLOSSARY_CATEGORY_ID}

  • 术语表术语：projects/{PROJECT_ID}/locations/{LOCATION_NAME}/glossaries/{GLOSSARY_ID}/terms/{GLOSSARY_TERM_ID}

  • 数据产品：projects/{PROJECT_ID}/locations/{LOCATION_NAME}/dataProducts/{DATA_PRODUCT_ID}

  • 数据网域：projects/{PROJECT_ID}/locations/{LOCATION_NAME}/dataDomains/{DATA_DOMAIN_ID}

  • 流程：projects/{PROJECT_ID}/locations/{LOCATION_NAME}/processes/{PROCESS_ID}

  • 运行作业：projects/{PROJECT_ID}/locations/{LOCATION_NAME}/processes/{PROCESS_ID}/runs/{RUN_ID}

  • 沿袭事件：projects/{PROJECT_ID}/locations/{LOCATION_NAME}/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 是资源路径中的最后一个部分。

对于大多数资源（条目组、条目类型、切面类型、条目链接、 元数据作业、元数据 Feed、术语表、术语表类别、术语表术语、 数据产品和数据网域）， {ENTRY_GROUP_ID}、{ENTRY_TYPE_ID}、 {ASPECT_TYPE_ID}、{ENTRY_LINK_ID}、 {METADATA_JOB_ID}、{METADATA_FEED_ID}、 {GLOSSARY_ID}、{GLOSSARY_CATEGORY_ID}、 {GLOSSARY_TERM_ID}、{DATA_PRODUCT_ID} 和 {DATA_DOMAIN_ID} 等变量必须符合以下准则：

  • 以小写字母开头。

  • 包含 1 到 63 个字符。

  • 只能包含小写字母、数字、连字符和下划线。

  • 以数字或小写字母结尾。

{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。

对于数据沿袭资源（例如流程、运行作业和沿袭事件）， 变量 {PROCESS_ID}、{RUN_ID} 和 {LINEAGE_EVENT_ID} 必须符合以下准则：

  • 最多包含 200 个字符。

  • 只能包含字母（区分大小写）、数字、连字符、下划线、英文冒号和英文句点。

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_NAME}/entryGroups/@bigquery/entries/bigquery.googleapis.com/projects/test-project/datasets/test_dataset/tables/test_table