使用金鑰管理服務 API 管理金鑰

IBM Cloud® Hyper Protect Crypto Services 提供 金鑰管理服務 API 來儲存、擷取及產生加密金鑰。

擷取 IBM Cloud 認證

若要使用 API,您需要產生服務及鑑別認證。 若要收集您的認證,請執行下列動作:

  1. 產生一個 IBM Cloud IAM 存取記號
  2. 擷取用來唯一識別 Hyper Protect Crypto Services 服務實例的實例 ID。

形成您的金鑰管理服務 API 請求

對服務發出 API 呼叫時,請根據最初佈建 Hyper Protect Crypto Services 實例的方式來建構 API 要求。

若要建置您的要求,請將地區服務端點與適當的鑑別認證配對。 例如,如果您已建立 us-south 地區的服務實例,請使用下列端點及 API 標頭來瀏覽服務中的金鑰:

如果您在 2024 年 4 月 12 日之後在某些區域建立實例,您可能需要使用新格式的新 API 終端節點:<instance_ID>.ep11.<REGION>.hs-crypto.appdomain.cloud。 可用日期因地區而異。 有關支援的區域、可用日期和新端點 URL 的更多信息,請參閱 新端點

curl -X GET \
    https://<INSTANCE_ID>.api.us-south.hs-crypto.appdomain.cloud/api/v2/keys \
    -H 'accept: application/vnd.ibm.collection+json' \
    -H 'authorization: Bearer <access_token>' \
    -H 'bluemix-instance: <instance_ID>'
  • 代替 <port> 與您的 API 端點的連接埠號碼。 您可以透過 概觀 > 金鑰管理端點 URL,在已佈建服務實例儀表板中取得 <port>。 或者,您可以動態地 檢索 API 端點 URL

    請注意,Hyper Protect Crypto Services 實例的埠範圍介於 8000- 19999 之間。

    回覆值包含:

    {
      "instance_id": "<instance_ID>",
      "kms": {
        "public": "<instance_ID>.api.<region>.hs-crypto.appdomain.cloud",
        "private":"<instance_ID>.api.private.<region>.hs-crypto.appdomain.cloud"
      },
        "ep11": {
        "public": "<instance_ID>.ep11.<region>.hs-crypto.appdomain.cloud",
        "private":"<instance_ID>.ep11.private.<region>.hs-crypto.appdomain.cloud"
      }
    }
    

    對於金鑰管理服務,請使用 <region><instance_ID> 在裡面 kms 部分。

  • 代替 <access_token><instance_ID> 使用您檢索到的服務和驗證憑證。

想要在發生錯誤時追蹤您的 API 要求嗎? 當您在 cURL 要求中包含 -v 旗標時,即會在回應標頭中獲得 correlation-id 值。 您可以使用此值來產生要求的關聯,並追蹤要求以進行除錯。

下一步

您已準備好開始管理加密金鑰和資料。 要了解有關以編程方式管理密鑰的更多信息,查看金鑰管理服務 API 參考文檔