命名 Knowledge Catalog 資源的指南

Google Cloud 資源是指您在Google Cloud中建立或使用的任何元件。這些資源是您在平台上執行的應用程式和系統的建構區塊。

如要進一步瞭解一般 Google Cloud 資源命名，請參閱「資源名稱」。

資源命名格式

下表列出 Knowledge Catalog 資源的完整資源名稱格式：

資源 完整資源名稱格式
項目群組 projects/{PROJECT_ID}/locations/{LOCATION}/entryGroups/{ENTRY_GROUP_ID}
Entry 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}
Entry link projects/{PROJECT_ID}/locations/{LOCATION}/entryGroups/{ENTRY_GROUP_ID}/entryLinks/{ENTRY_LINK_ID}
中繼資料工作 projects/{PROJECT_ID}/locations/{LOCATION}/metadataJobs/{METADATA_JOB_ID}
中繼資料動態消息 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 之外，所有資源 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