依專案查看金鑰

本頁說明如何查看 Google Cloud 專案資源中的鑰環和金鑰。

事前準備

請先完成本節所述的設定步驟，才能查看金鑰環和金鑰。

啟用 API

如要使用 API 查看鑰匙圈和金鑰，請啟用 Cloud KMS Inventory API。

啟用 API

必要的角色

如要取得查看金鑰所需的權限，請要求管理員為您授予專案的 Cloud KMS 檢視者 (roles/cloudkms.viewer) IAM 角色。如要進一步瞭解如何授予角色，請參閱「管理專案、資料夾和機構的存取權」。

這個預先定義的角色具備查看金鑰所需的權限。如要查看確切的必要權限，請展開「必要權限」部分：

所需權限

您必須具備下列權限，才能查看金鑰：

  • cloudkms.keyRings.list
  • cloudkms.cryptoKeys.list
  • cloudkms.locations.list
  • resourcemanager.projects.get

您或許還可透過自訂角色或其他預先定義的角色取得這些權限。

查看金鑰環

控制台

  1. 前往 Google Cloud 控制台的「Key Rings」頁面。

    前往「Key Ring」(金鑰環)

  2. 選用步驟：如要篩選鑰匙圈清單，請在 filter_list Filter 方塊中輸入搜尋字詞，然後按下 Enter 鍵。

  3. 選用：如要依欄中的值排序清單，請按一下欄標題。

查看金鑰環時，您可以選取金鑰環，查看相關聯的金鑰和匯入工作詳細資料。

查看金鑰

您可以使用 Google Cloud 控制台查看專案資源中建立的金鑰。

控制台

  1. 前往 Google Cloud 控制台的「Key Inventory」頁面。

    前往「重點廣告空間」

  2. 選用步驟：如要篩選鍵值清單，請在「filter_list」filter_list 方塊中輸入搜尋字詞，然後按下 Enter 鍵。

  3. 選用：如要依欄中的值排序清單，請按一下欄標題。

gcloud CLI

如要在指令列上使用 Cloud KMS，請先安裝或升級至最新版 Google Cloud CLI。

gcloud kms inventory list-keys --project PROJECT_ID

將 PROJECT_ID 替換為您要查看金鑰清單的專案名稱。

如需所有旗標和可能值的相關資訊，請搭配 --help 旗標執行指令。

API

這些範例會使用 curl 做為 HTTP 用戶端，以示範如何使用 API。如要進一步瞭解存取控制，請參閱「存取 Cloud KMS API」。

curl "https://kmsinventory.googleapis.com/v1/projects/PROJECT_ID/cryptoKeys"
    --request "GET" \
    --header "x-goog-user-project: CALLING_PROJECT_ID"
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer TOKEN"

更改下列內容：

  • PROJECT_ID：包含金鑰環的專案 ID。
  • CALLING_PROJECT_ID：您呼叫 KMS Inventory API 的專案 ID。

查看金鑰時，您可以選取金鑰，查看金鑰的詳細資料，包括相關聯的金鑰版本。

重要詳細資訊

金鑰目錄會提供專案中加密金鑰的完整資訊。主要商品目錄中的房源包括：

  • 金鑰名稱：金鑰名稱。
  • 狀態：根據主要金鑰版本的狀態，顯示目前的金鑰狀態。這個欄位僅適用於對稱金鑰。
    • 可用：已啟用主要金鑰版本。這個金鑰可用於加密及解密資料。
    • 無法使用：主要金鑰版本已停用或為空白。金鑰無法用於加密資料。
    • GCP 支援：外部代管金鑰的金鑰 (不一定是外部代管金鑰本身) 可供使用。
  • 金鑰環：父項金鑰環的名稱。
  • 位置：主要素材資源所在的位置。
  • 目前輪替週期：上次輪替金鑰的日期和時間。這個欄位會顯示目前金鑰版本的建立時間。
  • 輪替頻率：金鑰目前的輪替頻率。
  • 下次輪替：下次排定金鑰輪替的日期。系統會在這個日期自動建立新的金鑰版本。
  • 防護等級：金鑰的防護等級，例如 HSM 或軟體。
  • 透過虛擬私有雲連至 EKM：針對透過虛擬私有雲存取的外部金鑰，金鑰使用的透過虛擬私有雲連至 EKM名稱。這個欄位預設為隱藏，如果鍵的保護層級為 External via VPC 以外的值，則會留空。
  • 用途：金鑰可能用於哪些情境。
  • 標籤：套用至鍵的標籤。

限制

  • 每個位置的「金鑰環」分頁最多可顯示 1,000 個資源 (包括金鑰環、金鑰和金鑰版本)。如要查看專案和地點的鑰匙圈，其中資源超過 1,000 個，請使用 keyRings.list API。

  • 「金鑰目錄」分頁最多可顯示每個專案的 20,000 項資源 (包括金鑰環、金鑰和金鑰版本)。如要查看擁有超過 20,000 個資源的專案金鑰，請使用 keyRings.cryptoKeys.list API。