管理資料網域

預覽

這項產品或功能適用《服務專屬條款》中「一般服務條款」一節的《正式發布前產品條款》。正式發布前的產品和功能是按照「原樣」提供，支援範圍可能有限。 詳情請參閱推出階段說明。

Knowledge Catalog (舊稱 Dataplex Universal Catalog) 可讓您使用 Google Cloud 控制台和 REST API，查看、更新及刪除資料網域和子網域。您可以檢查包含的資源、修改顯示名稱和標籤，或移除空白網域，讓階層結構與業務結構保持一致。

事前準備

管理資料網域前，請確認您具備必要角色，並已啟用 API。

啟用 API

啟用 Dataplex API (如果尚未啟用)。

啟用 API 所需的角色

您必須具備 serviceusage.services.enable 權限，才能啟用 API。如果您建立了專案，可能已透過「擁有者」角色 (roles/owner) 取得這項權限。否則，您可以透過「Service Usage 管理員」角色 (roles/serviceusage.serviceUsageAdmin) 取得這項權限。瞭解如何授予角色。

啟用 API

必要的角色

如要取得管理資料網域所需的權限，請要求管理員授予您專案的下列 IAM 角色：

• 更新資料網域和資源繫結：Dataplex 資料網域設定編輯者 (roles/dataplex.dataDomainEditor)
• 查看資料網域和繫結的設定：Dataplex 資料網域設定檢視者 (roles/dataplex.dataDomainViewer)

如要進一步瞭解如何授予角色，請參閱「管理專案、資料夾和組織的存取權」。

您或許也能透過自訂角色或其他預先定義的角色，取得必要權限。

查看資料網域和子網域

查看特定專案中的資料網域和子網域。

控制台

查看所有資料網域

1. 前往 Google Cloud 控制台的「Data domains」(資料網域) 頁面。

   前往「資料網域」

2. 表格會列出已建立的網域。按一下資料網域名稱旁的「展開」箭頭 ，即可查看巢狀子網域。

查看資料網域和子網域詳細資料

1. 前往 Google Cloud 控制台的「Data domains」(資料網域) 頁面。

   前往「資料網域」

2. 按一下要查看的網域或子網域名稱。

3. 「Domain Details」(網域詳細資料) 頁面會顯示下列分頁：

   • 總覽：提供網域總覽，以及必要和選用層面的清單。
   • 資源：列出這個網域中的資源。這份清單只會顯示直接加入網域的資料夾、專案和資源。

REST

查看資料網域和子網域

如要查看資料網域，請使用 projects.locations.dataDomains.list 方法：

使用任何要求資料之前，請先修改下列項目的值：

• PROJECT_ID： Google Cloud 專案的 ID。
• LOCATION_ID：專案的區域。例如：us-central1。

HTTP 方法和網址：

GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains

請展開以下其中一個選項，以傳送要求：

curl (Linux、macOS 或 Cloud Shell)

注意：下列指令假設您已執行 gcloud init 或 gcloud auth login，透過使用者帳戶登入 gcloud CLI，或已使用 Cloud Shell 自動登入 gcloud CLI。您可以執行 gcloud auth list，查看目前使用的帳戶。

執行下列指令：

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains"

PowerShell (Windows)

注意：下列指令假設您已執行 gcloud init 或 gcloud auth login，透過使用者帳戶登入 gcloud CLI。您可以執行 gcloud auth list，查看目前使用的帳戶。

執行下列指令：

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

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains" | Select-Object -Expand Content

您應該會收到執行成功的狀態碼 (2xx) 和空白回應。

查看資料子網域

如要查看資料子網域，請使用 projects.locations.dataDomains.listSubdomains 方法：

使用任何要求資料之前，請先修改下列項目的值：

• PROJECT_ID： Google Cloud 專案的 ID。
• LOCATION_ID：父項資料網域所在的區域。例如：us-central1。
• DOMAIN_ID：父項資料網域的專屬 ID。

HTTP 方法和網址：

GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/DOMAIN_ID/subdomains

請展開以下其中一個選項，以傳送要求：

curl (Linux、macOS 或 Cloud Shell)

注意：下列指令假設您已執行 gcloud init 或 gcloud auth login，透過使用者帳戶登入 gcloud CLI，或已使用 Cloud Shell 自動登入 gcloud CLI。您可以執行 gcloud auth list，查看目前使用的帳戶。

執行下列指令：

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/DOMAIN_ID/subdomains"

PowerShell (Windows)

注意：下列指令假設您已執行 gcloud init 或 gcloud auth login，透過使用者帳戶登入 gcloud CLI。您可以執行 gcloud auth list，查看目前使用的帳戶。

執行下列指令：

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

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/DOMAIN_ID/subdomains" | Select-Object -Expand Content

您應該會收到執行成功的狀態碼 (2xx) 和空白回應。

使用 filter 參數，列出屬於特定父項網域的子網域：

使用任何要求資料之前，請先修改下列項目的值：

• PROJECT_ID： Google Cloud 專案的 ID。
• LOCATION_ID：父項資料網域所在的區域。例如：us-central1。
• PARENT_DOMAIN_ID：父項資料網域的專屬 ID。

HTTP 方法和網址：

GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains?filter=parent_data_domain="projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/PARENT_DOMAIN_ID"

請展開以下其中一個選項，以傳送要求：

curl (Linux、macOS 或 Cloud Shell)

注意：下列指令假設您已執行 gcloud init 或 gcloud auth login，透過使用者帳戶登入 gcloud CLI，或已使用 Cloud Shell 自動登入 gcloud CLI。您可以執行 gcloud auth list，查看目前使用的帳戶。

執行下列指令：

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains?filter=parent_data_domain="projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/PARENT_DOMAIN_ID""

PowerShell (Windows)

注意：下列指令假設您已執行 gcloud init 或 gcloud auth login，透過使用者帳戶登入 gcloud CLI。您可以執行 gcloud auth list，查看目前使用的帳戶。

執行下列指令：

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

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains?filter=parent_data_domain="projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/PARENT_DOMAIN_ID"" | Select-Object -Expand Content

您應該會收到執行成功的狀態碼 (2xx) 和空白回應。

查看資料網域詳細資料

如要取得網域或子網域詳細資料，請使用 projects.locations.dataDomains.get 方法：

使用任何要求資料之前，請先修改下列項目的值：

• PROJECT_ID： Google Cloud 專案的 ID。
• LOCATION_ID：資料網域所在的區域。例如：us-central1。
• DOMAIN_ID：資料網域或子網域的專屬 ID。

HTTP 方法和網址：

GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/DOMAIN_ID

請展開以下其中一個選項，以傳送要求：

curl (Linux、macOS 或 Cloud Shell)

注意：下列指令假設您已執行 gcloud init 或 gcloud auth login，透過使用者帳戶登入 gcloud CLI，或已使用 Cloud Shell 自動登入 gcloud CLI。您可以執行 gcloud auth list，查看目前使用的帳戶。

執行下列指令：

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/DOMAIN_ID"

PowerShell (Windows)

注意：下列指令假設您已執行 gcloud init 或 gcloud auth login，透過使用者帳戶登入 gcloud CLI。您可以執行 gcloud auth list，查看目前使用的帳戶。

執行下列指令：

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

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/DOMAIN_ID" | Select-Object -Expand Content

您應該會收到執行成功的狀態碼 (2xx) 和空白回應。

更新資料網域或子網域

您可以更新網域的顯示名稱、說明和標籤。網域建立後，即無法變更網域 ID 或位置。

控制台

1. 前往 Google Cloud 控制台的「Data domains」(資料網域) 頁面。

   前往「資料網域」

2. 按一下網域或子網域名稱，前往詳細資料頁面。

3. 按一下頂端列中的 [Edit] (編輯)。

4. 更新「顯示名稱」或「說明」。

5. 按一下 [儲存]。

REST

如要更新資料網域，請使用 projects.locations.dataDomains.patch 方法：

注意： 您必須使用 updateMask 查詢參數指定要更新的欄位，以免覆寫其他屬性。

使用任何要求資料之前，請先修改下列項目的值：

• PROJECT_ID： Google Cloud 專案的 ID。
• LOCATION_ID：資料網域所在的區域。例如：us-central1。
• DOMAIN_ID：資料網域或子網域的專屬 ID。

HTTP 方法和網址：

PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/DOMAIN_ID?updateMask=description,labels

JSON 要求主體：

{
  "description": "Updated description for the domain",
  "labels": {
    "status": "active"
  }
}

請展開以下其中一個選項，以傳送要求：

curl (Linux、macOS 或 Cloud Shell)

注意：下列指令假設您已執行 gcloud init 或 gcloud auth login，透過使用者帳戶登入 gcloud CLI，或已使用 Cloud Shell 自動登入 gcloud CLI。您可以執行 gcloud auth list，查看目前使用的帳戶。

將要求主體儲存在名為 request.json 的檔案中，然後執行下列指令：

curl -X PATCH \
     -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/dataDomains/DOMAIN_ID?updateMask=description,labels"

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 PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/DOMAIN_ID?updateMask=description,labels" | Select-Object -Expand Content

您應該會收到執行成功的狀態碼 (2xx) 和空白回應。

刪除資料網域或子網域

只能刪除空白的資料網域。您必須先刪除所有子網域，並移除與網域相關聯的所有資源繫結，才能刪除網域本身。如果網域並非空白，刪除要求會失敗並顯示錯誤。

控制台

1. 前往 Google Cloud 控制台的「Data domains」(資料網域) 頁面。

   前往「資料網域」

2. 按一下網域或子網域名稱，前往詳細資料頁面。

3. 按一下頂端列的「刪除」。

4. 輸入資料網域或子網域名稱，確認刪除。

5. 點選「刪除」。

REST

如要刪除資料網域，請使用 projects.locations.dataDomains.delete 方法：

使用任何要求資料之前，請先修改下列項目的值：

• PROJECT_ID： Google Cloud 專案的 ID。
• LOCATION_ID：資料網域所在的區域。例如：us-central1。
• DOMAIN_ID：資料網域或子網域的專屬 ID。

HTTP 方法和網址：

DELETE https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/DOMAIN_ID

請展開以下其中一個選項，以傳送要求：

curl (Linux、macOS 或 Cloud Shell)

注意：下列指令假設您已執行 gcloud init 或 gcloud auth login，透過使用者帳戶登入 gcloud CLI，或已使用 Cloud Shell 自動登入 gcloud CLI。您可以執行 gcloud auth list，查看目前使用的帳戶。

執行下列指令：

curl -X DELETE \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/DOMAIN_ID"

PowerShell (Windows)

注意：下列指令假設您已執行 gcloud init 或 gcloud auth login，透過使用者帳戶登入 gcloud CLI。您可以執行 gcloud auth list，查看目前使用的帳戶。

執行下列指令：

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

Invoke-WebRequest `
    -Method DELETE `
    -Headers $headers `
    -Uri "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/DOMAIN_ID" | Select-Object -Expand Content

您應該會收到執行成功的狀態碼 (2xx) 和空白回應。

後續步驟

• 進一步瞭解資料網域。
• 進一步瞭解資源繫結和納入。
• 瞭解如何建立資料網域。
• 瞭解如何使用資料網域。