IBM Cloud Hyper Protect Crypto Services CLI

Hyper Protect Crypto Services 提供多個 IBM Cloud® CLI 外掛程式，讓您對服務實例執行動作: 金鑰管理 CLI 外掛程式、授信金鑰登錄 (TKE) CLI 外掛程式、憑證管理程式 CLI 外掛程式，以及 Unified Key Orchestrator (UKO) CLI 外掛程式。

Hyper Protect Crypto Services 金鑰管理 CLI 外掛程式

Hyper Protect Crypto Services 與 Key Protect CLI 外掛程式整合，因此您可以使用 Key Protect CLI 外掛程式來管理 Hyper Protect Crypto Services 實例中的根金鑰和標準金鑰。

如需如何設定 Hyper Protect Crypto Services的 Key Protect CLI 外掛程式，請參閱使用 CLI 執行金鑰管理作業。
如需完整的金鑰管理 CLI 參考資料，請參閱 Key Protect CLI 指令參考資料。

Hyper Protect Crypto Services 授信金鑰登錄 CLI 外掛程式

您可以使用 TKE CLI 外掛程式來管理指派給您帳戶的加密單位。

安裝 TKE CLI 外掛程式

若要安裝 TKE CLI 外掛程式，請遵循下列步驟：

安裝 IBM Cloud CLI。

IBM Cloud CLI 需要 Java™ 1.8.0。使用 IBM Cloud CLI 來執行指令的字首是 ibmcloud。
使用下列指令安裝最新的 TKE 外掛程式：
```
ibmcloud plugin install tke
```
當 IBM Cloud CLI 及外掛程式的更新可用時，您會在指令行收到通知。請務必保持最新的 CLI，以便您可以使用最新指令。您可以執行 ibmcloud plugin list 來檢視所有已安裝外掛程式的現行版本。
在工作站上設定 CLOUDTKEFILES 環境變數。指定您要在其中建立及儲存工作站檔案及簽章工作站檔案的目錄。如果該目錄不存在，請建立一個。
- 在 Linux™ 作業系統或 MacOS上，將下列行新增至 .bash_profile 檔案:
```
export CLOUDTKEFILES=<path>
```
  例如，您可以將 path 指定為 /Users/tke-files。
- 在 Windows™ 作業系統的 控制台中，在搜尋方框中鍵入 environment variable，以尋找「環境變數」視窗。建立 CLOUDTKEFILES 環境變數並設定金鑰檔路徑的值。例如，C:\users\tke-files。
專用端點 URL 在 private 中傳回。對於金鑰管理端點，請使用 kms 區段中傳回的值。 KP_PRIVATE_ADDR 環境變數用於設定公用端點和專用端點的 API 端點 URL。如果您要使用公用端點，則請務必將 KP_PRIVATE_ADDR 環境變數設定為 public 區段的 kms 欄位中所傳回的公用端點 URL。

TKE CLI 外掛程式指令

表 1. 說明 TKE CLI 外掛程式指令
指令名稱	說明	範例
`tke auto-init`	自動起始設定服務實例。	`ibmcloud tke auto-init`
`tke auto-mk-rotate`	使用回復 HSM 中隨機產生的主要金鑰值自動旋轉主要金鑰。	`ibmcloud tke auto-mk-rotate`
`tke auto-recover`	自動將現行主要金鑰值從回復 HSM 複製到相同資源群組中的其他加密單位。	`ibmcloud tke auto-recover`
`tke`	在 IBM Cloud中管理加密單位。	`ibmcloud tke`
`tke cryptounit-add`	將加密單位新增至要使用的加密單位集。	`ibmcloud tke cryptounit-add`
`tke cryptounit-admin-add`	將加密單位管理者新增至選取的加密單位。	`ibmcloud tke cryptounit-admin-add`
`tke cryptounit-admin-rm`	從選取的加密單位移除加密單位管理者。	`ibmcloud tke cryptounit-admin-rm`
`tke cryptounit-admins`	列出所選取加密單位中安裝的管理者。	`ibmcloud tke cryptounit-admins`
`tke cryptounit-compare`	比較所選取加密單位的配置設定。	`ibmcloud tke cryptounit-compare`
`tke cryptounit-cp-btc`	在選取的加密單位中啟用比特幣 (BTC) 相關函數。	`ibmcloud tke cryptounit-cp-btc`
`tke cryptounit-cp-eddsa`	在選取的加密單位中啟用 Edwards 曲線數位簽章演算法 (EdDSA) 功能。	`ibmcloud tke cryptounit-cp-eddsa`
`tke cryptounit-cp-sig-other`	在選取的加密單位中啟用非橢圓曲線 DSA、非 Edwards 曲線 DSA 數位簽章函數。	`ibmcloud tke cryptounit-cp-sig-other`
`tke cryptounit-exit-impr`	結束所選取加密單位中的印記模式。 (已淘汰。請改用 `cryptounit-thrhld-set`。)	`ibmcloud tke cryptounit-exit-impr`
`tke cryptounit-mk`	顯示所選取加密單位的主要金鑰登錄。	`ibmcloud tke cryptounit-mk`
`tke cryptounit-mk-clrcur`	清除現行主要金鑰登錄。	`ibmcloud tke cryptounit-mk-clrcur`
`tke cryptounit-mk-clrnew`	清除新的主要金鑰登錄。	`ibmcloud tke cryptounit-mk-clrnew`
`tke cryptounit-mk-commit`	確定新的主要金鑰登錄。	`ibmcloud tke cryptounit-mk-commit`
`tke cryptounit-mk-load`	載入新的主要金鑰登錄。	`ibmcloud tke cryptounit-mk-load`
`tke cryptounit-mk-rotate`	在金鑰管理金鑰儲存庫中重新包裝主要金鑰和加密金鑰之後，將新的主要金鑰登錄中的主要金鑰提升至現行主要金鑰登錄。	`ibmcloud tke cryptounit-mk-rotate`
`tke cryptounit-mk-setimm`	在主要金鑰暫存器上立即設定。	`ibmcloud tke cryptounit-mk-setimm`
`tke cryptounit-rm`	從要使用的加密單位集移除加密單位。	`ibmcloud tke cryptounit-rm`
`tke cryptounit-thrhld-set`	設定所選取加密單位的簽章臨界值。	`ibmcloud tke cryptounit-thrhld-set`
`tke cryptounit-thrhlds`	顯示所選取加密單位的簽章臨界值。	`ibmcloud tke cryptounit-thrhlds`
`tke cryptounit-zeroize`	將選取的加密單位歸零。	`ibmcloud tke cryptounit-zeroize`
`tke cryptounits`	顯示現行資源群組的加密單位。	`ibmcloud tke cryptounits`
`tke failover-enable`	在佈建服務實例之後啟用或新增失效接手加密單位。	`ibmcloud tke failover-enable`
`tke mk-add`	建立並儲存新的 EP11 主要金鑰部分。	`ibmcloud tke mk-add`
`tke mk-rm`	從此工作站移除 EP11 主要金鑰部分。	`ibmcloud tke mk-rm`
`tke mks`	列出儲存在此工作站上的 EP11 主要金鑰組件。	`ibmcloud tke mks`
`tke sigkey-add`	產生並儲存新的簽章金鑰。	`ibmcloud tke sigkey-add`
`tke sigkey-rm`	從此工作站移除簽章金鑰。	`ibmcloud tke sigkey-rm`
`tke sigkey-sel`	選取用來簽署指令的簽章金鑰。	`ibmcloud tke sigkey-sel`
`tke sigkeys`	列出儲存在此工作站上的簽章金鑰。	`ibmcloud tke sigkeys`
`tke help`, `tke h`	顯示說明。	`ibmcloud tke help`

如需每個指令的相關資訊，請在 TKE CLI 外掛程式中執行下列指令：

ibmcloud tke help <command_name>

Hyper Protect Crypto Services 憑證管理程式 CLI 外掛程式

對於 Hyper Protect Crypto Services 標準方案，您可以使用憑證管理程式 CLI 外掛程式來管理 GREP11 或 PKCS #11 API 連線中第二層鑑別的憑證和管理者簽章金鑰。

安裝憑證管理程式 CLI 外掛程式

若要安裝憑證管理程式 CLI 外掛程式，請遵循下列步驟:

安裝 IBM Cloud CLI。

IBM Cloud CLI 需要 Java™ 1.8.0。使用 IBM Cloud CLI 來執行指令的字首是 ibmcloud。
使用下列指令來安裝最新的憑證管理程式外掛程式:
```
ibmcloud plugin install hpcs-cert-mgr
```
當 IBM Cloud CLI 及外掛程式的更新可用時，您會在指令行收到通知。請務必保持最新的 CLI，以便您可以使用最新指令。您可以執行 ibmcloud plugin list 來檢視所有已安裝外掛程式的現行版本。

Certificate manager CLI 外掛程式指令

下列列出所有可用的憑證管理程式 CLI 指令及其對應的用法。如需說明資訊，請使用 -h 或 --help。

hpcs-cert-mgr adminkey get

使用這個指令來擷取憑證管理者的管理者簽章金鑰。

ibmcloud hpcs-cert-mgr adminkey get --crn HPCS_CRN [--private]

指令選項

-- crn HPCS_CRN

必要。 Hyper Protect Crypto Services 實例的 crn。您可以使用 ibmcloud resource service-instances --long 指令來擷取 crn。

--private

選用。如果您使用這個選項，憑證管理程式伺服器 URL 會指向私密網路。例如: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443。 region 是您在其中登入 IBM Cloud的地理區域縮寫。在此情況下，您需要使用專用網路來連接服務實例。

範例

export HPCS_CRN=crn:v1:staging:public:xxx:yyy:zzz

ibmcloud hpcs-cert-mgr adminkey get --crn ${HPCS_CRN}

輸出

指令會傳回類似下列範例的輸出:

connecting to server [cert-mgr.us-south.hs-crypto.cloud.ibm.com:443]...
+------------+--------+
| PROPERTIES | VALUES |
+------------+--------+
| PublicKey  |        |
+------------+--------+

command completed successfully.

hpcs-cert-mgr adminkey set

請使用這個指令來建立憑證管理者的管理者簽章金鑰，以連接至憑證管理程式伺服器。

ibmcloud hpcs-cert-mgr adminkey set --crn HPCS_CRN [--private]

指令選項

-- crn HPCS_CRN

必要。 Hyper Protect Crypto Services 實例的 crn。您可以使用 ibmcloud resource service-instances --long 指令來擷取 crn。

--private

選用。如果您使用這個選項，憑證管理程式伺服器 URL 會指向私密網路。例如: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443。 region 是您在其中登入 IBM Cloud的地理區域縮寫。在此情況下，您需要使用專用網路來連接服務實例。

範例

export HPCS_CRN=crn:v1:staging:public:xxx:yyy:zzz

ibmcloud hpcs-cert-mgr adminkey set --crn ${HPCS_CRN}

輸出

指令會傳回類似下列範例的輸出:

connecting to server [cert-mgr.us-south.hs-crypto.cloud.ibm.com:443]...
+------------+-----------------------------------------------------------------------------------+
| KEYTYPE    | FILE                                                                              |
+------------+-----------------------------------------------------------------------------------+
| PrivateKey | /Users/username/.hpcs-cert-mgr-cfg/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.priv  |
| PublicKey  | /Users/username/.hpcs-cert-mgr-cfg/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.pub   |
+------------+-----------------------------------------------------------------------------------+

An automatically generated keypair is stored locally and configured to node remotely, please keep the keypair carefully!!!

command completed successfully.

hpcs-cert-mgr adminkey update

使用這個指令來重新整理及更新憑證管理者的管理者簽章金鑰。

ibmcloud hpcs-cert-mgr adminkey update --crn HPCS_CRN --admin-priv-key ADMIN_PRIV_KEY [--private]

指令選項

-- crn HPCS_CRN

必要。 Hyper Protect Crypto Services 實例的 crn。您可以使用 ibmcloud resource service-instances --long 指令來擷取 crn。

--admin-priv-key ADMIN_PRIV_KEY

必要。儲存在本端工作站上之現有私密金鑰的檔案路徑。私密金鑰用於對實例憑證管理程式伺服器簽署此指令動作。

--private

選用。如果您使用這個選項，憑證管理程式伺服器 URL 會指向私密網路。例如: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443。 region 是您在其中登入 IBM Cloud的地理區域縮寫。在此情況下，您需要使用專用網路來連接服務實例。

範例

export HPCS_CRN=crn:v1:staging:public:xxx:yyy:zzz

export ADMIN_PRIV_KEY=/Users/admin1/.hpcs-cert-mgr-cfg/44de77d2-599b-0089-2f0f-bad8d1c94a7c.priv

ibmcloud hpcs-cert-mgr adminkey update --crn ${HPCS_CRN} --admin-priv-key ${ADMIN_PRIV_KEY}

輸出

指令會傳回類似下列範例的輸出:

connecting to server [cert-mgr.us-south.hs-crypto.cloud.ibm.com:443]...
+------------+-----------------------------------------------------------------------------------+
| KEYTYPE    | FILE                                                                              |
+------------+-----------------------------------------------------------------------------------+
| PrivateKey | /Users/username/.hpcs-cert-mgr-cfg/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.priv  |
| PublicKey  | /Users/username/.hpcs-cert-mgr-cfg/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.pub   |
+------------+-----------------------------------------------------------------------------------+

An automatically generated keypair is stored locally and configured to node remotely, please keep the keypair carefully!!!

command completed successfully.

hpcs-cert-mgr adminkey delete

使用這個指令來刪除憑證管理者的管理者簽章金鑰。

ibmcloud hpcs-cert-mgr adminkey delete --crn HPCS_CRN --admin-priv-key ADMIN_PRIV_KEY [--private]

指令選項

-- crn HPCS_CRN

必要。 Hyper Protect Crypto Services 實例的 crn。您可以使用 ibmcloud resource service-instances --long 指令來擷取 crn。

--admin-priv-key ADMIN_PRIV_KEY

必要。儲存在本端工作站上之現行私密金鑰的檔案路徑。私密金鑰用於對實例憑證管理程式伺服器簽署此指令動作。

--private

選用。如果您使用這個選項，憑證管理程式伺服器 URL 會指向私密網路。例如: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443。 region 是您在其中登入 IBM Cloud的地理區域縮寫。在此情況下，您需要使用專用網路來連接服務實例。

範例

export HPCS_CRN=crn:v1:staging:public:xxx:yyy:zzz

export ADMIN_PRIV_KEY=/Users/admin1/.hpcs-cert-mgr-cfg/44de77d2-599b-0089-2f0f-bad8d1c94a7c.priv

ibmcloud hpcs-cert-mgr adminkey delete --crn ${HPCS_CRN} --admin-priv-key ${ADMIN_PRIV_KEY}

輸出

指令會傳回類似下列範例的輸出:

connecting to server [cert-mgr.us-south.hs-crypto.cloud.ibm.com:443]...
command completed successfully.

hpcs-cert-mgr cert get

使用這個指令來擷取實例憑證管理程式伺服器上的用戶端憑證。

ibmcloud hpcs-cert-mgr cert get --crn HPCS_CRN --cert-id CERT_ID [--cert-store-file CERT_FILE] [--private]

指令選項

-- crn HPCS_CRN

必要。 Hyper Protect Crypto Services 實例的 crn。您可以使用 ibmcloud resource service-instances --long 指令來擷取 crn。

-- cert-id CERT_ID

必要。您要擷取之用戶端憑證的字串 ID。

--cert-store-file CERT_FILE

選用。儲存所擷取憑證的檔案路徑。如果您指定此選項，則會在本端工作站上建立檔案並儲存憑證內容。

--private

選用。如果您使用這個選項，憑證管理程式伺服器 URL 會指向私密網路。例如: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443。 region 是您在其中登入 IBM Cloud的地理區域縮寫。在此情況下，您需要使用專用網路來連接服務實例。

範例

export HPCS_CRN=crn:v1:staging:public:xxx:yyy:zzz

ibmcloud hpcs-cert-mgr cert get --crn ${HPCS_CRN} --cert-id testcert --cert-store-file c/b/cert.pem

輸出

指令會傳回類似下列範例的輸出:

connecting to server [cert-mgr.us-south.hs-crypto.cloud.ibm.com:443]...
------------------ The returned certification ------------------
-----BEGIN CERTIFICATE-----
MIIFazCCA10gAwIBAgIUVW/gPwBtOKHEwCL.........
............................................
............................................
................................FkQF0tfc6cg=
-----END CERTIFICATE-----

command completed successfully.

hpcs-cert-mgr cert set

請使用這個指令來設定實例憑證管理程式伺服器的用戶端憑證。

ibmcloud hpcs-cert-mgr cert set --crn HPCS_CRN --admin-priv-key ADMIN_PRIV_KEY --cert-id CERT_ID --cert CERT_FILE [--private]

指令選項

-- crn HPCS_CRN

必要。 Hyper Protect Crypto Services 實例的 crn。您可以使用 ibmcloud resource service-instances --long 指令來擷取 crn。

--admin-priv-key ADMIN_PRIV_KEY

必要。儲存在本端工作站上之現行私密金鑰的檔案路徑。私密金鑰用於對實例憑證管理程式伺服器簽署此指令動作。

-- cert-id CERT_ID

必要。您要指派給憑證以方便識別的字串 ID。

-- cert CERT_FILE

必要。儲存在工作站上的憑證檔。建議使用 IBM Cloud Certificate Manager 來訂購及管理應用程式和服務的 SSL/TLS 憑證。

--private

選用。如果您使用這個選項，憑證管理程式伺服器 URL 會指向私密網路。例如: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443。 region 是您在其中登入 IBM Cloud的地理區域縮寫。在此情況下，您需要使用專用網路來連接服務實例。

範例

export HPCS_CRN=crn:v1:staging:public:xxx:yyy:zzz

export CERT=/Users/admin1/cert.pem

export ADMIN_PRIV_KEY=/Users/admin1/.hpcs-cert-mgr-cfg/44de77d2-599b-0089-2f0f-bad8d1c94a7c.priv

ibmcloud hpcs-cert-mgr cert set --crn ${HPCS_CRN} --admin-priv-key ${ADMIN_PRIV_KEY} --cert-id testcert --cert ${CERT}

輸出

指令會傳回類似下列範例的輸出:

connecting to server [cert-mgr.us-south.hs-crypto.cloud.ibm.com:443]...
command completed successfully.

hpcs-cert-mgr cert list

使用這個指令來列出管理者為實例憑證管理程式伺服器管理的所有憑證。

ibmcloud hpcs-cert-mgr cert list --crn HPCS_CRN [--private]

指令選項

-- crn HPCS_CRN

必要。 Hyper Protect Crypto Services 實例的 crn。您可以使用 ibmcloud resource service-instances --long 指令來擷取 crn。

--private

選用。如果您使用這個選項，憑證管理程式伺服器 URL 會指向私密網路。例如: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443。 region 是您在其中登入 IBM Cloud的地理區域縮寫。在此情況下，您需要使用專用網路來連接服務實例。

範例

export HPCS_CRN=crn:v1:staging:public:xxx:yyy:zzz

ibmcloud hpcs-cert-mgr cert list --crn ${HPCS_CRN}

輸出

指令會傳回類似下列範例的輸出:

connecting to server [cert-mgr.us-south.hs-crypto.cloud.ibm.com:443]...
+------------+----------------------------------------+
| CERTID     | CERT                                   |
| testcert   | -----BEGIN CERTIFICATE-----            |
|            | MIIFazCCA10gAwIBAgIUVW/gPwBtOKHEwCL....|
|            |........................................|
|            |............................FkQF0tfc6cg=|
|            | -----END CERTIFICATE-----              |
|            |                                        |
| testcert2  | -----BEGIN CERTIFICATE-----            |
|            | MIIFazCCA10gAwIBAgIUVW/gPwBtOKHEwCL....|
|            |........................................|
|            |............................FkQF0tfc6cg=|
|            | -----END CERTIFICATE-----              |
|            |                                        |
+------------+----------------------------------------+

command completed successfully.

hpcs-cert-mgr cert delete

使用這個指令來刪除實例憑證管理程式伺服器的用戶端憑證。

ibmcloud hpcs-cert-mgr cert delete --crn HPCS_CRN --admin-priv-key ADMIN_PRIV_KEY --cert-id CERT_ID [--private]

指令選項

-- crn HPCS_CRN

必要。 Hyper Protect Crypto Services 實例的 crn。您可以使用 ibmcloud resource service-instances --long 指令來擷取 crn。

--admin-priv-key ADMIN_PRIV_KEY

必要。儲存在本端工作站上之現行私密金鑰的檔案路徑。私密金鑰用於對實例憑證管理程式伺服器簽署此指令動作。

-- cert-id CERT_ID

必要。您要刪除之憑證的字串 ID。

--private

選用。如果您使用這個選項，憑證管理程式伺服器 URL 會指向私密網路。例如: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443。 region 是您在其中登入 IBM Cloud的地理區域縮寫。在此情況下，您需要使用專用網路來連接服務實例。

範例

export HPCS_CRN=crn:v1:staging:public:xxx:yyy:zzz

export ADMIN_PRIV_KEY=/Users/admin1/.hpcs-cert-mgr-cfg/44de77d2-599b-0089-2f0f-bad8d1c94a7c.priv

ibmcloud hpcs-cert-mgr cert delete --crn ${HPCS_CRN} --admin-priv-key ${ADMIN_PRIV_KEY} --cert-id testcert

輸出

指令會傳回類似下列範例的輸出:

connecting to server [cert-mgr.us-south.hs-crypto.cloud.ibm.com:443]...
command completed successfully.

Hyper Protect Crypto Services Unified Key Orchestrator CLI 外掛程式

您可以使用 Unified Key Orchestrator CLI 外掛程式，透過 Unified Key Orchestrator 方案來管理 Hyper Protect Crypto Services 實例的儲存庫、金鑰儲存庫及受管理金鑰。

安裝 Unified Key Orchestrator CLI 外掛程式

若要安裝 Unified Key Orchestrator CLI 外掛程式，請遵循下列步驟:

安裝 IBM Cloud CLI。

IBM Cloud CLI 需要 Java™ 1.8.0。使用 IBM Cloud CLI 來執行指令的字首是 ibmcloud。
使用下列指令安裝最新的 Unified Key Orchestrator CLI 外掛程式:
```
ibmcloud plugin install hpcs
```
當 IBM Cloud CLI 及外掛程式的更新可用時，您會在指令行收到通知。請務必保持最新的 CLI，以便您可以使用最新指令。您可以執行 ibmcloud plugin list 來檢視所有已安裝外掛程式的現行版本。
在工作站上設定 UKO_URL 環境變數。
```
export UKO_URL=<UKO_endpoint_URL>
```
將 <UKO_endpoint_URL> 取代為您的實例 UKO 端點 URL。您可以透過概觀 > 連接 > Unified Key Orchestrator 端點 URL，取得已佈建服務實例使用者介面儀表板上的端點 URL。或者，您可以動態擷取 API 端點 URL。

Unified Key Orchestrator CLI 外掛程式指令

下列列出所有可用的 Unified Key Orchestrator CLI 指令及其對應的用法。如需說明資訊，請使用 -h 或 --help。

hpcs uko managed-keys

列出實例中的所有受管理金鑰。可以依下列參數排序 :label、algorithm、state、activation-date、deactivation-date、created-at、updated-at、size、vault-id。

如果未設定 --all-pages 選項，則指令只會擷取集合的單一頁面。

ibmcloud hpcs uko managed-keys [--vault-id VAULT-ID] [--algorithm ALGORITHM] [--state STATE] [--limit LIMIT] [--offset OFFSET] [--sort SORT] [--label LABEL] [--activation-date ACTIVATION-DATE] [--activation-date-min ACTIVATION-DATE-MIN] [--activation-date-max ACTIVATION-DATE-MAX] [--deactivation-date DEACTIVATION-DATE] [--deactivation-date-min DEACTIVATION-DATE-MIN] [--deactivation-date-max DEACTIVATION-DATE-MAX] [--expiration-date EXPIRATION-DATE] [--expiration-date-min EXPIRATION-DATE-MIN] [--expiration-date-max EXPIRATION-DATE-MAX] [--created-at CREATED-AT] [--created-at-min CREATED-AT-MIN] [--created-at-max CREATED-AT-MAX] [--updated-at UPDATED-AT] [--updated-at-min UPDATED-AT-MIN] [--updated-at-max UPDATED-AT-MAX] [--rotated-at-min ROTATE-AT-MIN] [--rotated-at-max ROTATE-AT-MAX] [--size SIZE] [--size-min SIZE-MIN] [--size-max SIZE-MAX] [--referenced-keystores-type REFERENCED-KEYSTORES-TYPE] [--referenced-keystores-name REFERENCED-KEYSTORES-NAME] [--instances-keystore-type INSTANCES-KEYSTORE-TYPE] [--template-name TEMPLATE-NAME] [--template-id TEMPLATE-ID] [--template-type TEMPLATE-TYPE] [--managing-systems MANAGING-SYSTEMS]

指令選項

-- vault-id ([]字串)

選用。儲存庫的通用唯一 ID (UUID)。您可以使用 ibmcloud hpcs uko managed-keys 指令來擷取 UUID。長度必須為 36 個字元。清單項目必須符合正規表示式 /^[-0-9a-z]+$/。

-- algorithm ([]string)

選用。所傳回金鑰的演算法。可以設定的值為 aes、rsa、hmac、ec、des 及 dilithium。

-- state ([]string)

選用。所傳回金鑰的狀態。預設值為 ["pre_activation","active"]。可以設定的值為: pre_activation、active、deactivated、destroyed、compromised 及 destroyed_compromised。

-- limit (int64)

選用。要擷取的金鑰數目。最大值為 1000。最小值為 1。預設值為 20。

-- offset (int64)

選用。要跳過的金鑰數目。最小值為 0。

-- sort ([]字串)

選用。排序順序。預設值為 ["-updated_at"]。清單項目必須符合正規表示式 /^-?[a-z0-9_.\\[\\],-]+$/。

-- label (字串)

選用。金鑰的標籤。值必須符合正規表示式 /.+/。

-- activation-date (string)

選用。只傳回其啟動日期符合參數的受管理金鑰。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

--activation-date-min (字串)

選用。只傳回其啟動日期等於或晚於參數值的受管理金鑰。此查詢參數無法與 activation_date 查詢參數一起使用。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

--activation-date-max (字串)

選用。只傳回其啟動日期等於或早於參數值的受管理金鑰。此查詢參數無法與 activation_date 查詢參數一起使用。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

--deactivast-date (字串)

選用。只傳回停用日期符合參數的受管理金鑰。此查詢參數無法與 expiration_date 查詢參數一起使用。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

--deactiva-date-min (字串)

選用。只傳回停用日期等於或晚於參數值的受管理金鑰。此查詢參數無法與 deactivation_date、expiration_date、expiration_date_min 及 expiration_date_max 查詢參數一起使用。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

--deactiva-date-max (字串)

選用。只傳回停用日期等於或早於參數值的受管理金鑰。此查詢參數無法與 deactivation_date、expiration_date、expiration_date_min 及 expiration_date_max 查詢參數一起使用。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

-- expiration-date (string)

選用。只傳回停用日期符合參數的受管理金鑰。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

--expiration-date-min (字串)

選用。只傳回停用日期等於或晚於參數值的受管理金鑰。此查詢參數無法與 deactivation_date、expiration_date、deactivation_date_min 及 deactivation_date_max 查詢參數一起使用。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

--expiration-date-max (字串)

選用。只傳回停用日期等於或早於參數值的受管理金鑰。此查詢參數無法與 deactivation_date、expiration_date、deactivation_date_min 及 deactivation_date_max 查詢參數一起使用。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

-- created-at (字串)

選用。只傳回其建立時間符合參數的受管理金鑰。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

--created-at-min (字串)

選用。只傳回其建立時間等於或晚於參數值的受管理金鑰。此查詢參數無法與 created_at 查詢參數一起使用。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

--created-at-max (字串)

選用。只傳回其建立時間等於或早於參數值的受管理金鑰。此查詢參數無法與 created_at 查詢參數一起使用。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

-- updated-at (字串)

選用。只傳回更新時間符合參數的受管理金鑰。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

--updated-at-min (字串)

選用。只傳回更新時間在參數值之後的受管理金鑰。此查詢參數無法與 updated_at 查詢參數一起使用。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

--updated-at-max (字串)

選用。只傳回更新時間早於參數值的受管理金鑰。此查詢參數無法與 updated_at 查詢參數一起使用。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

--rotated-at-min (字串)

選用。只傳回其旋轉時間在參數值之後的受管理金鑰。

--rotated-at-max (字串)

選用。只傳回其旋轉時間早於參數值的受管理金鑰。

-- size (int64)

選用。金鑰的大小。

-- size-min (int64)

選用。金鑰的大小下限。此查詢參數無法與 size 查詢參數一起使用。

-- size-max (int64)

選用。金鑰的大小上限。此查詢參數無法與 size 查詢參數一起使用。

--referenced-keystores-type ([]字串)

選用。所參照金鑰儲存庫的類型。可以設定的值為 aws_kms、azure_key_vault、ibm_cloud_kms、google_kms 及 cca。

--referenced-keystores-name ([]字串)

選用。所參照金鑰儲存庫的名稱。清單項目必須符合正規表示式 /[^,]+/。

--instances-keystore-type ([]字串)

選用。其中一個實例支援的金鑰儲存庫類型。可以設定的值為 aws_kms、azure_key_vault、ibm_cloud_kms、google_kms 及 cca。

-- template-name (字串)

只傳回其範本名稱以字串開頭的受管理金鑰。

-- template-id (字串[])

只傳回具有給定範本 UUID 的受管理金鑰。

-- template-type (string[])

僅傳回具有給定範本類型的受管理金鑰。可以設定的值為 user_defined、shadow 和 system。

-- managing-systems

僅傳回具有給定管理系統的受管理金鑰。可以設定的值為 web 和 workstation。

-- all-pages (bool)

選用。呼叫多個要求，以顯示受管理金鑰集合的所有頁面。

範例

ibmcloud hpcs uko managed-keys --output json

輸出

標頭:

表格。指令輸出標頭
名稱	類型	說明
X-相關性-ID	字串	附加至容許參照特定交易或事件鏈的要求及訊息的唯一 ID。

指令會傳回類似下列範例的輸出:

{
  "total_count": 4,
  "limit": 20,
  "offset": 0,
  "first": {
    "href": "/v4/managed_keys?vault.id=5295ad47-2ce9-43c3-b9e7-e5a9482c362b&limit=20&offset=0'"
  },
  "last": {
    "href": "/v4/managed_keys?vault.id=5295ad47-2ce9-43c3-b9e7-e5a9482c362b&limit=20&offset=0"
  },
  "managed_keys": [
    {
      "id": "35f690df-064a-4758-8694-b2f011810701",
      "vault": {
        "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
        "name": "Vault-1",
        "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
      },
      "template": {
        "id": "6393e930-562c-4042-b324-45c37d3d49d9",
        "name": "AZURE-template-920",
        "type": [
          "user_defined"
        ],
        "href": "/v4/templates/6393e930-562c-4042-b324-45c37d3d49d9"
      },
      "version": "1,",
      "description": "AZURE KEY",
      "label": "AZUREproduction2029",
      "state": "active",
      "size": "2048",
      "algorithm": "rsa",
      "verification_patterns": [
        {
          "method": "PUB-HASH-SHA-1",
          "value\"": "947AA69D48EEE487048AF2999DADB8DA55769529"
        }
      ],
      "activation_date": "2028-07-14",
      "expiration_date": "2029-09-25",
      "label_tags": [
        {
          "name": "APP",
          "value": "AZURE"
        },
        {
          "name": "ENV",
          "value": "production"
        },
        {
          "name": "lay",
          "value": "2029"
        }
      ],
      "tags": [
        {
          "name": "TAG-1",
          "value": "AZURE-TAG"
        }
      ],
      "created_at": "2023-06-05T11:33:54Z",
      "updated_at": "2023-06-05T11:33:54Z",
      "created_by": "IBMid-665000MCAR",
      "updated_by": "IBMid-665000MCAR",
      "referenced_keystores": [
        {
          "keystore": [
            {
              "id": "2e124fa5-9ef6-406c-bb2f-9ad049ff1073",
              "name": "Azure Keystore",
              "type": "azure_key_vault",
              "href": "v4/managed_keys/3dab42dc-6941-4841-8d27-4dabcc5aa09e"
            }
          ]
        }
      ],
      "instances": [
        {
          "id": "acb332dd-216c-44dd-8593-02bd2119ec62",
          "label_in_keystore\"": "AZUREproduction2029",
          "keystore": {
            "group": "Production AZURE GB",
            "type": "azure_key_vault"
          },
          "azure_key_protection_level": "software"
        }
      ],
      "href": "/v4/managed_keys/35f690df-064a-4758-8694-b2f011810701",
      "status_in_keystores": [
        {
          "keystore": [
            {
              "id": "2e124fa5-9ef6-406c-bb2f-9ad049ff1073",
              "name": "Azure Keystore",
              "type": "azure_key_vault",
              "href": "v4/managed_keys/3dab42dc-6941-4841-8d27-4dabcc5aa09e"
            }
          ],
          "status": "active",
          "keystore_sync_flag": "ok",
          "keystore_sync_flag_detail": "active_key_is_active_in_keystore",
          "key_id_in_keystore": "d1e2525c-62c8-4df2-9173-69e1a7bc8cdb/d1e2525c-62c8-4df2-9173-69e1a7bc8cdb"
        }
      ]
    },
    {
      "id": "ceb54688-827c-4e31-afa8-4c0122465a5b",
      "vault": {
        "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
        "name": "EXAMPLE-VAULT",
        "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
      },
      "template": {
        "id": "7a4e3659-083b-4d77-8562-7081eb197e90",
        "name": "AWS-EXAMPLE-TEMPLATE",
        "type": [
          "user_defined"
        ],
        "href": "/v4/templates/7a4e3659-083b-4d77-8562-7081eb197e90"
      },
      "version": 1,
      "description": "AWS key template description",
      "label": "AWS-production-2029",
      "state": "active",
      "size": 256,
      "algorithm": "aes",
      "verification_patterns": [
        {
          "method\"": "ENC-ZERO",
          "value": "C05CA1"
        }
      ],
      "activation_date": "2028-07-14",
      "expiration_date": "2029-09-25",
      "label_tags": [
        {
          "name": "APP",
          "value": "AWS"
        },
        {
          "name": "ENV",
          "value": "production"
        },
        {
          "name": "lay",
          "value": "2029"
        }
      ],
      "tags": [
        {
          "name": "TAG-1",
          "value": "AWS-TAG"
        }
      ],
      "created_at": "2023-06-05T10:40:13Z",
      "updated_at": "2023-06-05T10:40:19Z",
      "created_by": "IBMid-665000MCAR",
      "updated_by": "IBMid-665000MCAR",
      "referenced_keystores": [
        {
          "id": "0743ae15-c594-476d-8e9a-1564740ace53",
          "name": "AWS KMS Keystore 335",
          "type": "aws_kms",
          "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
        }
      ],
      "instances": [
        {
          "id": "8c2bef79-dd15-477c-93f0-0ae62264d4b6",
          "label_in_keystore": "AWS-production-2029",
          "type": "secret_key",
          "keystore": {
            "group\"": "Production-AWS-DE",
            "type\"": "aws_kms"
          }
        }
      ],
      "href": "/v4/managed_keys/ceb54688-827c-4e31-afa8-4c0122465a5b",
      "status_in_keystores": [
        {
          "keystore": {
            "id": "0743ae15-c594-476d-8e9a-1564740ace53",
            "name": "AWS KMS Keystore 335",
            "type": "aws_kms",
            "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
          },
          "status": "active",
          "keystore_sync_flag": "ok",
          "keystore_sync_flag_detail": "active_key_is_active_in_keystore",
          "key_id_in_keystore": "arn:aws:kms:eu-central-1:584492040385:key/52eca0ad-79ca-4c16-8934-986ac5d14b73"
        }
      ]
    },
    {
      "id": "0beedc06-4608-48ae-8ae3-8b7bf3c2c39f",
      "vault": {
        "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
        "name": "Vault-2",
        "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
      },
      "template": {
        "id": "64f98479-392d-4af2-a076-77cc21b8c6f3",
        "name": "IBM-CLOUD-TEMPLATE",
        "type": [
          "user_defined"
        ],
        "href": "/v4/templates/64f98479-392d-4af2-a076-77cc21b8c6f3"
      },
      "version": 1,
      "description": "",
      "label": "IBMCloudProduction2029",
      "state": "active",
      "size": "256",
      "algorithm": "aes",
      "verification_patterns": [
        {
          "method": "ENC-ZERO",
          "value": "4ADDCB"
        }
      ],
      "activation_date": "2028-07-14",
      "expiration_date": "2029-09-25",
      "label_tags": [
        {
          "name": "APP",
          "value": "IBMCloud"
        },
        {
          "name": "ENV",
          "value": "Production"
        },
        {
          "name": "lay",
          "value": "2029"
        }
      ],
      "tags": [
        {
          "name": "TAG-1",
          "value": "AWS-TAG"
        }
      ],
      "created_at": "2023-06-05T11:59:47Z",
      "updated_at": "2023-06-05T11:59:47Z",
      "created_by": "IBMid-665000MCAR",
      "updated_by": "IBMid-665000MCAR",
      "referenced_keystores": [
        {
          "id": "0743ae15-c594-476d-8e9a-1564740ace53",
          "name": "IBM CLOUD KEYSTORE",
          "type": "ibm_cloud_kms",
          "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
        }
      ],
      "instances": [
        {
          "id": "0c5b14ea-a3dd-407c-af7c-fd74575ccbad",
          "label_in_keystore": "IBMCloudProduction2029",
          "type": "secret_key",
          "keystore": {
            "group": "Production External GB",
            "type": "ibm_cloud_kms"
          }
        }
      ],
      "href": "/v4/managed_keys/0beedc06-4608-48ae-8ae3-8b7bf3c2c39f",
      "status_in_keystores": [
        {
          "keystore": {
            "id": "0743ae15-c594-476d-8e9a-1564740ace53",
            "name": "IBM CLOUD KEYSTORE",
            "type": "ibm_cloud_kms",
            "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
          },
          "status": "active",
          "keystore_sync_flag": "ok",
          "keystore_sync_flag_detail": "active_key_is_active_in_keystore",
          "key_id_in_keystore": "804854d0-4eb7-416e-8ae2-45ba56921c8a/804854d0-4eb7-416e-8ae2-45ba56921c8a"
        }
      ]
    },
    {
      "id": "d7b8204c-4f8f-4ba1-b306-5434ae817f51",
      "vault": {
        "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
        "name": "Vault-3",
        "href": "v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
      },
      "template": {
        "id": "09d229e5-e330-4e85-a7ee-cc8555d38603",
        "name": "GOOGLE-TEMPLATE-86",
        "type": [
          "user_defined"
        ],
        "href": "/v4/templates/09d229e5-e330-4e85-a7ee-cc8555d38603"
      },
      "version": 1,
      "description": "Google Key",
      "label": "Google-Production-2029",
      "state": "active",
      "size": "256",
      "algorithm": "aes",
      "verification_patterns": [
        {
          "method\"": "ENC-ZERO",
          "value": "C3F432"
        }
      ],
      "activation_date": "2028-07-14",
      "expiration_date": "2029-09-25",
      "label_tags": [
        {
          "name": "APP",
          "value": "Google"
        },
        {
          "name": "ENV",
          "value": "Production"
        },
        {
          "name": "lay",
          "value": "2029"
        }
      ],
      "tags": [
        {
          "name": "TAG-1",
          "value": "Google-TAG"
        }
      ],
      "created_at": "2023-06-05T13:18:28",
      "updated_at": "2023-06-05T13:18:28Z",
      "created_by": "IBMid-665000MCAR",
      "updated_by": "IBMid-665000MCAR",
      "referenced_keystores": [
        {
          "id": "6e026faa-d44d-4a1a-aeea-0e1ef2840cba",
          "name": "Google Keystore",
          "type": "google_kms",
          "href": "/v4/keystores/6e026faa-d44d-4a1a-aeea-0e1ef2840cba"
        }
      ],
      "instances": [
        {
          "id": "ed74a984-2057-484c-9198-54839f3fec62",
          "label_in_keystore": "Google-Production-2029",
          "type": "secret_key",
          "keystore": {
            "group": "Production Google",
            "type": "google_kms"
          },
          "google_key_protection_level": "software",
          "google_key_purpose": "encrypt_decrypt",
          "google_kms_algorithm": "google_symmetric_encryption"
        }
      ],
      "href": "/v4/managed_keys/d7b8204c-4f8f-4ba1-b306-5434ae817f51",
      "status_in_keystores": [
        {
          "keystore": {
            "id": "6e026faa-d44d-4a1a-aeea-0e1ef2840cba",
            "name": "Google Keystore",
            "type": "google_kms",
            "href": "/v4/keystores/6e026faa-d44d-4a1a-aeea-0e1ef2840cba"
          },
          "status": "active",
          "keystore_sync_flag": "ok",
          "keystore_sync_flag_detail": "active_key_is_active_in_keystore",
          "key_id_in_keystore": "projects/plated-field-364019/locations/europe-west3/keyRings/uko-ring/cryptoKeys/ROBOT-Google-Key-05-06-nciYX/cryptoKeyVersions/1"
        }
      ]
    }
  ]
}

hpcs uko managed-key-create

根據所提供的範本建立新的金鑰。範本必須存在於實例中，您才能執行此指令。

ibmcloud hpcs uko managed-key-create --template-name TEMPLATE-NAME --vault VAULT --label LABEL [--tags TAGS] [--description DESCRIPTION]

指令選項

-- template-name (字串)

必要。建立金鑰時要使用的金鑰範本名稱。長度必須介於 1 到 30 個字元之間。該值必須符合正規表示式 /^[A-Za-z][A-Za-z0-9-]+$/。

-- vault (VaultReferenceInCreationRequest)

必要。要在其中建立受管理金鑰的儲存庫 ID。

-- label (字串)

必要。金鑰的標籤。長度必須介於 1 到 255 個字元之間。該值必須符合正規表示式 /^[A-Za-z0-9._ \/-]+$/。

-- tags (Tag [])

選用。與金鑰相關聯的鍵值組。長度必須介於 0 到 128 個項目之間。

--description (字串)

選用。受管理金鑰的說明。長度必須介於 0 到 200 個字元之間。該值必須符合正規表示式 /(.|\\n)*/。

範例

ibmcloud hpcs uko managed-key-create \
  --template-name=IBM-CLOUD-EXAMPLE-TEMPLATE \
  --vault='{"id": "93777bca-baef-4070-b9b5-a2e6079df1b4"}' \
  --label='IBM CLOUD KEY' \
  --tags='[{"name": "first-tag", "value": "for-IBM-CLOUD"}]' \
  --output json

輸出

標頭:

表格。指令輸出標頭
名稱	類型	說明
X-相關性-ID	字串	附加至容許參照特定交易或事件鏈的要求及訊息的唯一 ID。
位置	字串	新建立資源的路徑 (相對於環境定義根目錄)。
ETag	字串	資源特定版本的 ID。

指令會傳回類似下列範例的輸出:

{
  "id": "ceb54688-827c-4e31-afa8-4c0122465a5b",
  "vault": {
    "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
    "name": "AWS-EXAMPLE-VAULT",
    "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
  },
  "template": {
    "id": "7a4e3659-083b-4d77-8562-7081eb197e90",
    "name": "AWS-EXAMPLE-TEMPLATE",
    "type": [
      "user_defined"
    ],
    "href": "/v4/templates/7a4e3659-083b-4d77-8562-7081eb197e90"
  },
  "version": 1,
  "description": "AWS key template description",
  "label": "AWS-production-2029",
  "state": "active",
  "size": 256,
  "algorithm": "aes",
  "verification_patterns": [
    {
      "method\"": "ENC-ZERO",
      "value": "C05CA1"
    }
  ],
  "activation_date": "2028-07-14",
  "expiration_date": "2029-09-25",
  "label_tags": [
    {
      "name": "APP",
      "value": "AWS"
    },
    {
      "name": "ENV",
      "value": "production"
    },
    {
      "name": "lay",
      "value": "2029"
    }
  ],
  "tags": [
    {
      "name": "TAG-1",
      "value": "AWS-TAG"
    }
  ],
  "created_at": "2023-06-05T10:40:13Z",
  "updated_at": "2023-06-05T10:40:19Z",
  "created_by": "IBMid-665000MCAR",
  "updated_by": "IBMid-665000MCAR",
  "referenced_keystores": [
    {
      "id": "0743ae15-c594-476d-8e9a-1564740ace53",
      "name": "AWS KMS Keystore 335",
      "type": "aws_kms",
      "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
    }
  ],
  "instances": [
    {
      "id": "8c2bef79-dd15-477c-93f0-0ae62264d4b6",
      "label_in_keystore": "AWS-production-2029",
      "type": "secret_key",
      "keystore": {
        "group\"": "Production-AWS-DE",
        "type\"": "aws_kms"
      }
    }
  ],
  "href": "/v4/managed_keys/ceb54688-827c-4e31-afa8-4c0122465a5b",
  "status_in_keystores": [
    {
      "keystore": {
        "id": "0743ae15-c594-476d-8e9a-1564740ace53",
        "name": "AWS KMS Keystore 335",
        "type": "aws_kms",
        "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
      },
      "status": "active",
      "keystore_sync_flag": "ok",
      "keystore_sync_flag_detail": "active_key_is_active_in_keystore",
      "key_id_in_keystore": "arn:aws:kms:eu-central-1:584492040385:key/52eca0ad-79ca-4c16-8934-986ac5d14b73"
    }
  ]
}

hpcs uko managed-key-delete

從儲存庫中依金鑰 ID 刪除受管理金鑰。在執行此指令之前，請確定金鑰處於 已毀損 狀態。

ibmcloud hpcs uko managed-key-delete --id ID --if-match IF-MATCH

指令選項

-- id (字串)

必要。金鑰的 UUID。您可以使用 ibmcloud hpcs uko managed-keys 指令來擷取金鑰 UUID。

-- if-match (string)

必要。更新的前置條件，這是 GET 要求標頭中的 ETag 值。您可以使用 ibmcloud hpcs uko managed-key 指令來擷取 ETag。

範例

ibmcloud hpcs uko managed-key-delete \
  --id=21a7498e-2ae4-47ee-85ac-a19bf64e92fa \
  --if-match=2022-05-27T10:15:38Z

輸出

標頭:

表格。指令輸出標頭
名稱	類型	說明
X-相關性-ID	字串	附加至容許參照特定交易或事件鏈的要求及訊息的唯一 ID。

指令會傳回類似下列範例的輸出:

...
OK

hpcs uko managed-key

透過指定金鑰 ID 來擷取受管理金鑰及其詳細資料。

ibmcloud hpcs uko managed-key --id ID

指令選項

-- id (字串)

必要。金鑰的 UUID。您可以使用 ibmcloud hpcs uko managed-keys 指令來擷取金鑰 UUID。

範例

ibmcloud hpcs uko managed-key \
  --id=21a7498e-2ae4-47ee-85ac-a19bf64e92fa \
  --output json

輸出

標頭:

表格。指令輸出標頭
名稱	類型	說明
X-相關性-ID	字串	附加至容許參照特定交易或事件鏈的要求及訊息的唯一 ID。
ETag	字串	資源特定版本的 ID。

指令會傳回類似下列範例的輸出:

{
  "id": "ceb54688-827c-4e31-afa8-4c0122465a5b",
  "vault": {
    "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
    "name": "AWS-EXAMPLE-VAULT",
    "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
  },
  "template": {
    "id": "7a4e3659-083b-4d77-8562-7081eb197e90",
    "name": "AWS-EXAMPLE-TEMPLATE",
    "type": [
      "user_defined"
    ],
    "href": "/v4/templates/7a4e3659-083b-4d77-8562-7081eb197e90"
  },
  "version": 1,
  "description": "AWS key template description",
  "label": "AWS-production-2029",
  "state": "active",
  "size": 256,
  "algorithm": "aes",
  "verification_patterns": [
    {
      "method\"": "ENC-ZERO",
      "value": "C05CA1"
    }
  ],
  "activation_date": "2028-07-14",
  "expiration_date": "2029-09-25",
  "label_tags": [
    {
      "name": "APP",
      "value": "AWS"
    },
    {
      "name": "ENV",
      "value": "production"
    },
    {
      "name": "lay",
      "value": "2029"
    }
  ],
  "tags": [
    {
      "name": "TAG-1",
      "value": "AWS-TAG"
    }
  ],
  "created_at": "2023-06-05T10:40:13Z",
  "updated_at": "2023-06-05T10:40:19Z",
  "created_by": "IBMid-665000MCAR",
  "updated_by": "IBMid-665000MCAR",
  "referenced_keystores": [
    {
      "id": "0743ae15-c594-476d-8e9a-1564740ace53",
      "name": "AWS KMS Keystore 335",
      "type": "aws_kms",
      "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
    }
  ],
  "instances": [
    {
      "id": "8c2bef79-dd15-477c-93f0-0ae62264d4b6",
      "label_in_keystore": "AWS-production-2029",
      "type": "secret_key",
      "keystore": {
        "group\"": "Production-AWS-DE",
        "type\"": "aws_kms"
      }
    }
  ],
  "href": "/v4/managed_keys/ceb54688-827c-4e31-afa8-4c0122465a5b",
  "status_in_keystores": [
    {
      "keystore": {
        "id": "0743ae15-c594-476d-8e9a-1564740ace53",
        "name": "AWS KMS Keystore 335",
        "type": "aws_kms",
        "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
      },
      "status": "active",
      "keystore_sync_flag": "ok",
      "keystore_sync_flag_detail": "active_key_is_active_in_keystore",
      "key_id_in_keystore": "arn:aws:kms:eu-central-1:584492040385:key/52eca0ad-79ca-4c16-8934-986ac5d14b73"
    }
  ]
}

hpcs uko managed-key-update

更新受管理金鑰的屬性。您只能與其他變更分開修改金鑰的狀態。變更金鑰的狀態會影響金鑰儲存庫中加密作業的可用性。

ibmcloud hpcs uko managed-key-update --id ID --if-match IF-MATCH [--label LABEL] [--activation-date ACTIVATION-DATE] [--expiration-date EXPIRATION-DATE] [--tags TAGS] [--description DESCRIPTION]

指令選項

-- id (字串)

必要。金鑰的 UUID。您可以使用 ibmcloud hpcs uko managed-keys 指令來擷取金鑰 UUID。

-- if-match (string)

必要。更新的前置條件，這是 GET 要求標頭中的 ETag 值。您可以使用 ibmcloud hpcs uko managed-key 指令來擷取 ETag。

-- label (字串)

必要。金鑰的標籤。長度必須介於 1 到 255 個字元之間。該值必須符合正規表示式 /^[A-Za-z0-9._ \/-]+$/。

-- activation-date (strfmt.Date)

選用。必須以 YYYY-MM-DD 格式提供啟動日期。

-- expiration-date (strfmt.Date)

選用。必須以 YYYY-MM-DD 格式提供到期日。

-- tags (Tag [])

選用。與金鑰相關聯的鍵值組。長度必須介於 0 到 128 個項目之間。

--description (字串)

選用。受管理金鑰的說明。長度必須介於 0 到 200 個字元之間。該值必須符合正規表示式 /(.|\\n)*/。

範例

ibmcloud hpcs uko managed-key-update \
  --id=21a7498e-2ae4-47ee-85ac-a19bf64e92fa \
  --if-match=2022-05-26T14:18:10Z \
  --description="updated description" \
  --output json

輸出

標頭:

表格。指令輸出標頭
名稱	類型	說明
X-相關性-ID	字串	附加至容許參照特定交易或事件鏈的要求及訊息的唯一 ID。
ETag	字串	資源特定版本的 ID。

指令會傳回類似下列範例的輸出:

{
  "id": "ceb54688-827c-4e31-afa8-4c0122465a5b",
  "vault": {
    "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
    "name": "AWS-EXAMPLE-VAULT",
    "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
  },
  "template": {
    "id": "7a4e3659-083b-4d77-8562-7081eb197e90",
    "name": "AWS-EXAMPLE-TEMPLATE",
    "type": [
      "user_defined"
    ],
    "href": "/v4/templates/7a4e3659-083b-4d77-8562-7081eb197e90"
  },
  "version": 1,
  "description": "AWS key template description",
  "label": "AWS-production-2029",
  "state": "active",
  "size": 256,
  "algorithm": "aes",
  "verification_patterns": [
    {
      "method\"": "ENC-ZERO",
      "value": "C05CA1"
    }
  ],
  "activation_date": "2028-07-14",
  "expiration_date": "2029-09-25",
  "label_tags": [
    {
      "name": "APP",
      "value": "AWS"
    },
    {
      "name": "ENV",
      "value": "production"
    },
    {
      "name": "lay",
      "value": "2029"
    }
  ],
  "tags": [
    {
      "name": "TAG-1",
      "value": "AWS-TAG"
    }
  ],
  "created_at": "2023-06-05T10:40:13Z",
  "updated_at": "2023-06-05T10:40:19Z",
  "created_by": "IBMid-665000MCAR",
  "updated_by": "IBMid-665000MCAR",
  "referenced_keystores": [
    {
      "id": "0743ae15-c594-476d-8e9a-1564740ace53",
      "name": "AWS KMS Keystore 335",
      "type": "aws_kms",
      "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
    }
  ],
  "instances": [
    {
      "id": "8c2bef79-dd15-477c-93f0-0ae62264d4b6",
      "label_in_keystore": "AWS-production-2029",
      "type": "secret_key",
      "keystore": {
        "group\"": "Production-AWS-DE",
        "type\"": "aws_kms"
      }
    }
  ],
  "href": "/v4/managed_keys/ceb54688-827c-4e31-afa8-4c0122465a5b",
  "status_in_keystores": [
    {
      "keystore": {
        "id": "0743ae15-c594-476d-8e9a-1564740ace53",
        "name": "AWS KMS Keystore 335",
        "type": "aws_kms",
        "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
      },
      "status": "active",
      "keystore_sync_flag": "ok",
      "keystore_sync_flag_detail": "active_key_is_active_in_keystore",
      "key_id_in_keystore": "arn:aws:kms:eu-central-1:584492040385:key/52eca0ad-79ca-4c16-8934-986ac5d14b73"
    }
  ]
}

hpcs uko associated-resources-for-managed-key

取得與 IBM Cloud中受管理金鑰相關聯的資源清單。這些雲端資源由您指定的金鑰保護。

如果未設定 --all-pages 選項，則指令只會擷取集合的單一頁面。

ibmcloud hpcs uko associated-resources-for-managed-key --id ID [--limit LIMIT] [--offset OFFSET] [--sort SORT]

指令選項

-- id (字串)

必要。金鑰的 UUID。您可以使用 ibmcloud hpcs uko managed-keys 指令來擷取金鑰 UUID。

-- limit (int64)

選用。要擷取的資源數目。值必須介於 1 和 1000 之間。

-- offset (int64)

選用。要跳過的資源數目。最小值為 0。

-- sort ([]字串)

選用。排序順序。預設值為 ["name"]。清單項目必須符合正規表示式 /^-?[a-z0-9_.\\[\\],-]+$/。

-- all-pages (bool)

選用。呼叫多個要求，以顯示相關聯資源之集合的所有頁面。

範例

ibmcloud hpcs uko associated-resources-for-managed-key \
--id=93777bca-baef-4070-b9b5-a2e6079df1b4 \
--output json

輸出

標頭:

表格。指令輸出標頭
名稱	類型	說明
X-相關性-ID	字串	附加至容許參照特定交易或事件鏈的要求及訊息的唯一 ID。

指令會傳回類似下列範例的輸出:

{
  "total_count": 3,
  "limit": 20,
  "offset": 0,
  "first": {
    "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/managed_key/5295ad47-2ce9-43c3-b9e7-e5a9482c362b/associated_resources?limit=20"
  },
  "last": {
    "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/managed_key/5295ad47-2ce9-43c3-b9e7-e5a9482c362b/associated_resources?limit=20&offset=0"
  },
  "previous": {
    "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/managed_keys?offset=80"
  },
  "next": {
    "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/managed_keys?offset=120"
  },
  "associated_resources": [
    {
      "vault": {
        "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
        "name": "Test Vault Name",
        "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
      },
      "managed_key": {
        "id": "93777bca-baef-4070-b9b5-a2e6079df1b4",
        "name": "My Managed Key",
        "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/managed_keys/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
      },
      "referenced_keystore": {
        "id": "93777bca-baef-4070-b9b5-a2e6079df1b4",
        "name": "My Managed Key",
        "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/managed_keys/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
      },
      "key_id_in_keystore": "93777bca-baef-4070-b9b5-a2e6079df1b4",
      "type": "com_ibm_cloud_kms_registration",
      "com_ibm_cloud_kms_registration": {
        "prevents_key_deletion": false,
        "service_name": "cloud-object-storage",
        "service_instance_name": "Cloud Object Storage-7s",
        "crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/db995d8d9cc715cd99f13b0671d978b6:57da8e3a-a86d-4e01-b840-f22d36e6f23f:bucket:keyprotecttest",
        "description": "some description"
      }
    }
  ]
}

hpcs uko managed-keys-from-keystore

列出指派給金鑰儲存庫的所有受管理金鑰。

如果未設定 --all-pages 選項，則指令只會擷取集合的單一頁面。

ibmcloud hpcs uko managed-keys-from-keystore --id ID [--algorithm ALGORITHM] [--state STATE] [--limit LIMIT] [--offset OFFSET] [--sort SORT] [--label LABEL] [--activation-date ACTIVATION-DATE] [--activation-date-min ACTIVATION-DATE-MIN] [--activation-date-max ACTIVATION-DATE-MAX] [--deactivation-date DEACTIVATION-DATE] [--deactivation-date-min DEACTIVATION-DATE-MIN] [--deactivation-date-max DEACTIVATION-DATE-MAX] [--expiration-date EXPIRATION-DATE] [--expiration-date-min EXPIRATION-DATE-MIN] [--expiration-date-max EXPIRATION-DATE-MAX] [--created-at CREATED-AT] [--created-at-min CREATED-AT-MIN] [--created-at-max CREATED-AT-MAX] [--updated-at UPDATED-AT] [--updated-at-min UPDATED-AT-MIN] [--updated-at-max UPDATED-AT-MAX] [--rotate-at-min ROTATE-AT-MIN] [--rotate-at-max ROTATE-AT-MAX] [--size SIZE] [--size-min SIZE-MIN] [--size-max SIZE-MAX] [--template-name TEMPLATE-NAME] [--template-id TEMPLATE-ID] [--template-type TEMPLATE-TYPE]

指令選項

-- uko-vault (string)

必要。要進行更新之儲存庫的 UUID。您可以使用 ibmcloud hpcs uko vaults 指令來擷取 UUID。

-- id (字串)

必要。金鑰儲存庫的 UUID。您可以使用 ibmcloud hpcs uko keystores 指令來擷取 UUID。

-- algorithm (string)

選用。所傳回金鑰的演算法。可以設定的值為 aes、rsa、hmac 和 ec。

-- state (string)

選用。所傳回金鑰的狀態。預設值為 ["pre_activation","active"]。可以設定的值為: pre_activation、active、deactivated、destroyed。

-- limit (int64)

選用。要擷取的金鑰數目。值必須介於 1 和 1000 之間。

-- offset (int64)

選用。要跳過的金鑰數目。最小值為 0。

-- sort ([]字串)

選用。排序順序。預設值為 ["-updated_at"]。清單項目必須符合正規表示式 /^-?[a-z0-9_.\\[\\],-]+$/。

-- label (字串)

選用。金鑰的標籤。值必須符合正規表示式 /.+/。

-- activation-date (string)

選用。只傳回其啟動日期符合參數的受管理金鑰。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

--activation-date-min (字串)

選用。只傳回其啟動日期等於或晚於參數值的受管理金鑰。此查詢參數無法與 activation_date 查詢參數一起使用。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

--activation-date-max (字串)

選用。只傳回其啟動日期等於或早於參數值的受管理金鑰。此查詢參數無法與 activation_date 查詢參數一起使用。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

--deactivast-date (字串)

選用。只傳回停用日期符合參數的受管理金鑰。此查詢參數無法與 expiration_date 查詢參數一起使用。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

--deactiva-date-min (字串)

選用。只傳回停用日期等於或晚於參數值的受管理金鑰。此查詢參數無法與 deactivation_date、expiration_date、expiration_date_min 及 expiration_date_max 查詢參數一起使用。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

--deactiva-date-max (字串)

選用。只傳回停用日期等於或早於參數值的受管理金鑰。此查詢參數無法與 deactivation_date、expiration_date、expiration_date_min 及 expiration_date_max 查詢參數一起使用。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

-- expiration-date (string)

選用。只傳回停用日期符合參數的受管理金鑰。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

--expiration-date-min (字串)

選用。只傳回停用日期等於或晚於參數值的受管理金鑰。此查詢參數無法與 deactivation_date、expiration_date、deactivation_date_min 及 deactivation_date_max 查詢參數一起使用。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

--expiration-date-max (字串)

選用。只傳回停用日期等於或早於參數值的受管理金鑰。此查詢參數無法與 deactivation_date、expiration_date、deactivation_date_min 及 deactivation_date_max 查詢參數一起使用。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

-- created-at (字串)

選用。只傳回其建立時間符合參數的受管理金鑰。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

--created-at-min (字串)

選用。只傳回其建立時間等於或晚於參數值的受管理金鑰。此查詢參數無法與 created_at 查詢參數一起使用。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

--created-at-max (字串)

選用。只傳回其建立時間等於或早於參數值的受管理金鑰。此查詢參數無法與 created_at 查詢參數一起使用。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

-- updated-at (字串)

選用。只傳回更新時間符合參數的受管理金鑰。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

--updated-at-min (字串)

選用。只傳回更新時間在參數值之後的受管理金鑰。此查詢參數無法與 updated_at 查詢參數一起使用。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

--updated-at-max (字串)

選用。只傳回更新時間早於參數值的受管理金鑰。此查詢參數無法與 updated_at 查詢參數一起使用。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

--rotate-at-min (字串)

選用。只傳回其輪替日期晚於參數值的受管理金鑰。

--rotate-at-max (字串)

選用。僅傳回其輪替日期早於參數值的受管理金鑰。

-- size (int64)

選用。金鑰的大小。

-- size-min (int64)

選用。金鑰的大小下限。此查詢參數無法與 size 查詢參數一起使用。

-- size-max (int64)

選用。金鑰的大小上限。此查詢參數無法與 size 查詢參數一起使用。

-- template-name (字串)

只傳回其範本名稱以字串開頭的受管理金鑰。

-- template-id (字串[])

只傳回具有給定範本 UUID 的受管理金鑰。

-- template-type (string[])

僅傳回具有給定範本類型的受管理金鑰。可以設定的值為 user_defined、shadow 和 system。

-- all-pages (bool)

選用。呼叫多個要求，以顯示受管理金鑰集合的所有頁面。

範例

ibmcloud hpcs uko managed-keys-from-keystore \
  --id=f779c44d-b90e-4917-b8b0-28d4591fefda \
  --output json

輸出

標頭:

表格。指令輸出標頭
名稱	類型	說明
X-相關性-ID	字串	附加至容許參照特定交易或事件鏈的要求及訊息的唯一 ID。

指令會傳回類似下列範例的輸出:

{
  "total_count": 4,
  "limit": 20,
  "offset": 0,
  "first": {
    "href": "/v4/managed_keys?vault.id=5295ad47-2ce9-43c3-b9e7-e5a9482c362b&limit=20&offset=0'"
  },
  "last": {
    "href": "/v4/managed_keys?vault.id=5295ad47-2ce9-43c3-b9e7-e5a9482c362b&limit=20&offset=0"
  },
  "managed_keys": [
    {
      "id": "35f690df-064a-4758-8694-b2f011810701",
      "vault": {
        "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
        "name": "Vault-1",
        "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
      },
      "template": {
        "id": "6393e930-562c-4042-b324-45c37d3d49d9",
        "name": "AZURE-template-920",
        "type": [
          "user_defined"
        ],
        "href": "/v4/templates/6393e930-562c-4042-b324-45c37d3d49d9"
      },
      "version": "1,",
      "description": "AZURE KEY",
      "label": "AZUREproduction2029",
      "state": "active",
      "size": "2048",
      "algorithm": "rsa",
      "verification_patterns": [
        {
          "method": "PUB-HASH-SHA-1",
          "value\"": "947AA69D48EEE487048AF2999DADB8DA55769529"
        }
      ],
      "activation_date": "2028-07-14",
      "expiration_date": "2029-09-25",
      "label_tags": [
        {
          "name": "APP",
          "value": "AZURE"
        },
        {
          "name": "ENV",
          "value": "production"
        },
        {
          "name": "lay",
          "value": "2029"
        }
      ],
      "tags": [
        {
          "name": "TAG-1",
          "value": "AZURE-TAG"
        }
      ],
      "created_at": "2023-06-05T11:33:54Z",
      "updated_at": "2023-06-05T11:33:54Z",
      "created_by": "IBMid-665000MCAR",
      "updated_by": "IBMid-665000MCAR",
      "referenced_keystores": [
        {
          "keystore": [
            {
              "id": "2e124fa5-9ef6-406c-bb2f-9ad049ff1073",
              "name": "Azure Keystore",
              "type": "azure_key_vault",
              "href": "v4/managed_keys/3dab42dc-6941-4841-8d27-4dabcc5aa09e"
            }
          ]
        }
      ],
      "instances": [
        {
          "id": "acb332dd-216c-44dd-8593-02bd2119ec62",
          "label_in_keystore\"": "AZUREproduction2029",
          "keystore": {
            "group": "Production AZURE GB",
            "type": "azure_key_vault"
          },
          "azure_key_protection_level": "software"
        }
      ],
      "href": "/v4/managed_keys/35f690df-064a-4758-8694-b2f011810701",
      "status_in_keystores": [
        {
          "keystore": [
            {
              "id": "2e124fa5-9ef6-406c-bb2f-9ad049ff1073",
              "name": "Azure Keystore",
              "type": "azure_key_vault",
              "href": "v4/managed_keys/3dab42dc-6941-4841-8d27-4dabcc5aa09e"
            }
          ],
          "status": "active",
          "keystore_sync_flag": "ok",
          "keystore_sync_flag_detail": "active_key_is_active_in_keystore",
          "key_id_in_keystore": "d1e2525c-62c8-4df2-9173-69e1a7bc8cdb/d1e2525c-62c8-4df2-9173-69e1a7bc8cdb"
        }
      ]
    },
    {
      "id": "ceb54688-827c-4e31-afa8-4c0122465a5b",
      "vault": {
        "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
        "name": "EXAMPLE-VAULT",
        "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
      },
      "template": {
        "id": "7a4e3659-083b-4d77-8562-7081eb197e90",
        "name": "AWS-EXAMPLE-TEMPLATE",
        "type": [
          "user_defined"
        ],
        "href": "/v4/templates/7a4e3659-083b-4d77-8562-7081eb197e90"
      },
      "version": 1,
      "description": "AWS key template description",
      "label": "AWS-production-2029",
      "state": "active",
      "size": 256,
      "algorithm": "aes",
      "verification_patterns": [
        {
          "method\"": "ENC-ZERO",
          "value": "C05CA1"
        }
      ],
      "activation_date": "2028-07-14",
      "expiration_date": "2029-09-25",
      "label_tags": [
        {
          "name": "APP",
          "value": "AWS"
        },
        {
          "name": "ENV",
          "value": "production"
        },
        {
          "name": "lay",
          "value": "2029"
        }
      ],
      "tags": [
        {
          "name": "TAG-1",
          "value": "AWS-TAG"
        }
      ],
      "created_at": "2023-06-05T10:40:13Z",
      "updated_at": "2023-06-05T10:40:19Z",
      "created_by": "IBMid-665000MCAR",
      "updated_by": "IBMid-665000MCAR",
      "referenced_keystores": [
        {
          "id": "0743ae15-c594-476d-8e9a-1564740ace53",
          "name": "AWS KMS Keystore 335",
          "type": "aws_kms",
          "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
        }
      ],
      "instances": [
        {
          "id": "8c2bef79-dd15-477c-93f0-0ae62264d4b6",
          "label_in_keystore": "AWS-production-2029",
          "type": "secret_key",
          "keystore": {
            "group\"": "Production-AWS-DE",
            "type\"": "aws_kms"
          }
        }
      ],
      "href": "/v4/managed_keys/ceb54688-827c-4e31-afa8-4c0122465a5b",
      "status_in_keystores": [
        {
          "keystore": {
            "id": "0743ae15-c594-476d-8e9a-1564740ace53",
            "name": "AWS KMS Keystore 335",
            "type": "aws_kms",
            "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
          },
          "status": "active",
          "keystore_sync_flag": "ok",
          "keystore_sync_flag_detail": "active_key_is_active_in_keystore",
          "key_id_in_keystore": "arn:aws:kms:eu-central-1:584492040385:key/52eca0ad-79ca-4c16-8934-986ac5d14b73"
        }
      ]
    },
    {
      "id": "0beedc06-4608-48ae-8ae3-8b7bf3c2c39f",
      "vault": {
        "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
        "name": "Vault-2",
        "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
      },
      "template": {
        "id": "64f98479-392d-4af2-a076-77cc21b8c6f3",
        "name": "IBM-CLOUD-TEMPLATE",
        "type": [
          "user_defined"
        ],
        "href": "/v4/templates/64f98479-392d-4af2-a076-77cc21b8c6f3"
      },
      "version": 1,
      "description": "",
      "label": "IBMCloudProduction2029",
      "state": "active",
      "size": "256",
      "algorithm": "aes",
      "verification_patterns": [
        {
          "method": "ENC-ZERO",
          "value": "4ADDCB"
        }
      ],
      "activation_date": "2028-07-14",
      "expiration_date": "2029-09-25",
      "label_tags": [
        {
          "name": "APP",
          "value": "IBMCloud"
        },
        {
          "name": "ENV",
          "value": "Production"
        },
        {
          "name": "lay",
          "value": "2029"
        }
      ],
      "tags": [
        {
          "name": "TAG-1",
          "value": "AWS-TAG"
        }
      ],
      "created_at": "2023-06-05T11:59:47Z",
      "updated_at": "2023-06-05T11:59:47Z",
      "created_by": "IBMid-665000MCAR",
      "updated_by": "IBMid-665000MCAR",
      "referenced_keystores": [
        {
          "id": "0743ae15-c594-476d-8e9a-1564740ace53",
          "name": "IBM CLOUD KEYSTORE",
          "type": "ibm_cloud_kms",
          "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
        }
      ],
      "instances": [
        {
          "id": "0c5b14ea-a3dd-407c-af7c-fd74575ccbad",
          "label_in_keystore": "IBMCloudProduction2029",
          "type": "secret_key",
          "keystore": {
            "group": "Production External GB",
            "type": "ibm_cloud_kms"
          }
        }
      ],
      "href": "/v4/managed_keys/0beedc06-4608-48ae-8ae3-8b7bf3c2c39f",
      "status_in_keystores": [
        {
          "keystore": {
            "id": "0743ae15-c594-476d-8e9a-1564740ace53",
            "name": "IBM CLOUD KEYSTORE",
            "type": "ibm_cloud_kms",
            "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
          },
          "status": "active",
          "keystore_sync_flag": "ok",
          "keystore_sync_flag_detail": "active_key_is_active_in_keystore",
          "key_id_in_keystore": "804854d0-4eb7-416e-8ae2-45ba56921c8a/804854d0-4eb7-416e-8ae2-45ba56921c8a"
        }
      ]
    },
    {
      "id": "d7b8204c-4f8f-4ba1-b306-5434ae817f51",
      "vault": {
        "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
        "name": "Vault-3",
        "href": "v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
      },
      "template": {
        "id": "09d229e5-e330-4e85-a7ee-cc8555d38603",
        "name": "GOOGLE-TEMPLATE-86",
        "type": [
          "user_defined"
        ],
        "href": "/v4/templates/09d229e5-e330-4e85-a7ee-cc8555d38603"
      },
      "version": 1,
      "description": "Google Key",
      "label": "Google-Production-2029",
      "state": "active",
      "size": "256",
      "algorithm": "aes",
      "verification_patterns": [
        {
          "method\"": "ENC-ZERO",
          "value": "C3F432"
        }
      ],
      "activation_date": "2028-07-14",
      "expiration_date": "2029-09-25",
      "label_tags": [
        {
          "name": "APP",
          "value": "Google"
        },
        {
          "name": "ENV",
          "value": "Production"
        },
        {
          "name": "lay",
          "value": "2029"
        }
      ],
      "tags": [
        {
          "name": "TAG-1",
          "value": "Google-TAG"
        }
      ],
      "created_at": "2023-06-05T13:18:28",
      "updated_at": "2023-06-05T13:18:28Z",
      "created_by": "IBMid-665000MCAR",
      "updated_by": "IBMid-665000MCAR",
      "referenced_keystores": [
        {
          "id": "6e026faa-d44d-4a1a-aeea-0e1ef2840cba",
          "name": "Google Keystore",
          "type": "google_kms",
          "href": "/v4/keystores/6e026faa-d44d-4a1a-aeea-0e1ef2840cba"
        }
      ],
      "instances": [
        {
          "id": "ed74a984-2057-484c-9198-54839f3fec62",
          "label_in_keystore": "Google-Production-2029",
          "type": "secret_key",
          "keystore": {
            "group": "Production Google",
            "type": "google_kms"
          },
          "google_key_protection_level": "software",
          "google_key_purpose": "encrypt_decrypt",
          "google_kms_algorithm": "google_symmetric_encryption"
        }
      ],
      "href": "/v4/managed_keys/d7b8204c-4f8f-4ba1-b306-5434ae817f51",
      "status_in_keystores": [
        {
          "keystore": {
            "id": "6e026faa-d44d-4a1a-aeea-0e1ef2840cba",
            "name": "Google Keystore",
            "type": "google_kms",
            "href": "/v4/keystores/6e026faa-d44d-4a1a-aeea-0e1ef2840cba"
          },
          "status": "active",
          "keystore_sync_flag": "ok",
          "keystore_sync_flag_detail": "active_key_is_active_in_keystore",
          "key_id_in_keystore": "projects/plated-field-364019/locations/europe-west3/keyRings/uko-ring/cryptoKeys/ROBOT-Google-Key-05-06-nciYX/cryptoKeyVersions/1"
        }
      ]
    }
  ]
}

hpcs uko managed-key-ds

傳回受管理金鑰的金鑰儲存庫配送狀態。

ibmcloud hpcs uko managed-key-ds --id ID

指令選項

-- id (字串)

必要。金鑰的 UUID。您可以使用 ibmcloud hpcs uko managed-keys 指令來擷取金鑰 UUID。

範例

ibmcloud hpcs uko managed-key-ds \
  --id=21a7498e-2ae4-47ee-85ac-a19bf64e92fa \
  --output json

輸出

標頭:

表格。指令輸出標頭
名稱	類型	說明
X-相關性-ID	字串	附加至容許參照特定交易或事件鏈的要求及訊息的唯一 ID。

指令會傳回類似下列範例的輸出:

{
  "status_in_keystores": [
    {
      "keystore": {
        "id": "b28bf13d-f49d-4b00-8b8d-457d38ad1e15",
        "name": "AWS KMS Keystore Name",
        "type": "aws_kms",
        "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/keystores/b28bf13d-f49d-4b00-8b8d-457d38ad1e15"
      },
      "status": "not_present"
    }
  ]
}

hpcs uko managed-key-update-from-template

更新受管理金鑰，以符合相關聯金鑰範本的最新版本。您可以在金鑰範本所定義群組中的金鑰儲存庫上指派、啟動或取消啟動金鑰。

ibmcloud hpcs uko managed-key-update-from-template --id ID --if-match IF-MATCH [--dry-run DRY-RUN]

指令選項

-- id (字串)

必要。金鑰的 UUID。您可以使用 ibmcloud hpcs uko managed-keys 指令來擷取金鑰 UUID。

-- if-match (string)

必要。更新的前置條件，這是 GET 要求標頭中的 ETag 值。您可以使用 ibmcloud hpcs uko managed-key 指令來擷取 ETag。

--dry-run (布林)

選用。請勿建立、更新或刪除資源，僅驗證是否可以使用給定的要求順利建立、更新或刪除資源。預設值為 false。

範例

ibmcloud hpcs uko managed-key-update-from-template \
  --id=22c04c00-0687-4f10-b0ac-b9f01d68ee85 \
  --if-match=2022-05-27T12:27:37Z \
  --output json

輸出

標頭:

表格。指令輸出標頭
名稱	類型	說明
X-相關性-ID	字串	附加至容許參照特定交易或事件鏈的要求及訊息的唯一 ID。
ETag	字串	資源特定版本的 ID。

指令會傳回類似下列範例的輸出:

{
  "id": "ceb54688-827c-4e31-afa8-4c0122465a5b",
  "vault": {
    "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
    "name": "AWS-EXAMPLE-VAULT",
    "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
  },
  "template": {
    "id": "7a4e3659-083b-4d77-8562-7081eb197e90",
    "name": "AWS-EXAMPLE-TEMPLATE",
    "type": [
      "user_defined"
    ],
    "href": "/v4/templates/7a4e3659-083b-4d77-8562-7081eb197e90"
  },
  "version": 1,
  "description": "AWS key template description",
  "label": "AWS-production-2029",
  "state": "active",
  "size": 256,
  "algorithm": "aes",
  "verification_patterns": [
    {
      "method\"": "ENC-ZERO",
      "value": "C05CA1"
    }
  ],
  "activation_date": "2028-07-14",
  "expiration_date": "2029-09-25",
  "label_tags": [
    {
      "name": "APP",
      "value": "AWS"
    },
    {
      "name": "ENV",
      "value": "production"
    },
    {
      "name": "lay",
      "value": "2029"
    }
  ],
  "tags": [
    {
      "name": "TAG-1",
      "value": "AWS-TAG"
    }
  ],
  "created_at": "2023-06-05T10:40:13Z",
  "updated_at": "2023-06-05T10:40:19Z",
  "created_by": "IBMid-665000MCAR",
  "updated_by": "IBMid-665000MCAR",
  "referenced_keystores": [
    {
      "id": "0743ae15-c594-476d-8e9a-1564740ace53",
      "name": "AWS KMS Keystore 335",
      "type": "aws_kms",
      "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
    }
  ],
  "instances": [
    {
      "id": "8c2bef79-dd15-477c-93f0-0ae62264d4b6",
      "label_in_keystore": "AWS-production-2029",
      "type": "secret_key",
      "keystore": {
        "group\"": "Production-AWS-DE",
        "type\"": "aws_kms"
      }
    }
  ],
  "href": "/v4/managed_keys/ceb54688-827c-4e31-afa8-4c0122465a5b",
  "status_in_keystores": [
    {
      "keystore": {
        "id": "0743ae15-c594-476d-8e9a-1564740ace53",
        "name": "AWS KMS Keystore 335",
        "type": "aws_kms",
        "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
      },
      "status": "active",
      "keystore_sync_flag": "ok",
      "keystore_sync_flag_detail": "active_key_is_active_in_keystore",
      "key_id_in_keystore": "arn:aws:kms:eu-central-1:584492040385:key/52eca0ad-79ca-4c16-8934-986ac5d14b73"
    }
  ]
}

hpcs uko managed-key-activate

啟動受管理金鑰，並對與受管理金鑰相關聯的金鑰儲存庫群組中的金鑰儲存庫執行金鑰安裝或啟動作業。

ibmcloud hpcs uko managed-key-activate --id ID --if-match IF-MATCH

指令選項

-- id (字串)

必要。金鑰的 UUID。您可以使用 ibmcloud hpcs uko managed-keys 指令來擷取金鑰 UUID。

-- if-match (string)

必要。更新的前置條件，這是 GET 要求標頭中的 ETag 值。您可以使用 ibmcloud hpcs uko managed-key 指令來擷取 ETag。

範例

ibmcloud hpcs uko managed-key-activate \
  --id=21a7498e-2ae4-47ee-85ac-a19bf64e92fa \
  --if-match=2022-05-27T10:06:27Z \
  --output json

輸出

標頭:

表格。指令輸出標頭
名稱	類型	說明
X-相關性-ID	字串	附加至容許參照特定交易或事件鏈的要求及訊息的唯一 ID。
ETag	字串	資源特定版本的 ID。

指令會傳回類似下列範例的輸出:

{
  "id": "ceb54688-827c-4e31-afa8-4c0122465a5b",
  "vault": {
    "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
    "name": "AWS-EXAMPLE-VAULT",
    "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
  },
  "template": {
    "id": "7a4e3659-083b-4d77-8562-7081eb197e90",
    "name": "AWS-EXAMPLE-TEMPLATE",
    "type": [
      "user_defined"
    ],
    "href": "/v4/templates/7a4e3659-083b-4d77-8562-7081eb197e90"
  },
  "version": 1,
  "description": "AWS key template description",
  "label": "AWS-production-2029",
  "state": "active",
  "size": 256,
  "algorithm": "aes",
  "verification_patterns": [
    {
      "method\"": "ENC-ZERO",
      "value": "C05CA1"
    }
  ],
  "activation_date": "2028-07-14",
  "expiration_date": "2029-09-25",
  "label_tags": [
    {
      "name": "APP",
      "value": "AWS"
    },
    {
      "name": "ENV",
      "value": "production"
    },
    {
      "name": "lay",
      "value": "2029"
    }
  ],
  "tags": [
    {
      "name": "TAG-1",
      "value": "AWS-TAG"
    }
  ],
  "created_at": "2023-06-05T10:40:13Z",
  "updated_at": "2023-06-05T10:40:19Z",
  "created_by": "IBMid-665000MCAR",
  "updated_by": "IBMid-665000MCAR",
  "referenced_keystores": [
    {
      "id": "0743ae15-c594-476d-8e9a-1564740ace53",
      "name": "AWS KMS Keystore 335",
      "type": "aws_kms",
      "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
    }
  ],
  "instances": [
    {
      "id": "8c2bef79-dd15-477c-93f0-0ae62264d4b6",
      "label_in_keystore": "AWS-production-2029",
      "type": "secret_key",
      "keystore": {
        "group\"": "Production-AWS-DE",
        "type\"": "aws_kms"
      }
    }
  ],
  "href": "/v4/managed_keys/ceb54688-827c-4e31-afa8-4c0122465a5b",
  "status_in_keystores": [
    {
      "keystore": {
        "id": "0743ae15-c594-476d-8e9a-1564740ace53",
        "name": "AWS KMS Keystore 335",
        "type": "aws_kms",
        "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
      },
      "status": "active",
      "keystore_sync_flag": "ok",
      "keystore_sync_flag_detail": "active_key_is_active_in_keystore",
      "key_id_in_keystore": "arn:aws:kms:eu-central-1:584492040385:key/52eca0ad-79ca-4c16-8934-986ac5d14b73"
    }
  ]
}

hpcs uko managed-key-deactivate

取消啟動受管理金鑰，並對與受管理金鑰相關聯之金鑰儲存庫群組中的金鑰儲存庫執行取消啟動金鑰作業。

ibmcloud hpcs uko managed-key-deactivate --id ID --if-match IF-MATCH

指令選項

-- id (字串)

必要。金鑰的 UUID。您可以使用 ibmcloud hpcs uko managed-keys 指令來擷取金鑰 UUID。

-- if-match (string)

必要。更新的前置條件，這是 GET 要求標頭中的 ETag 值。您可以使用 ibmcloud hpcs uko managed-key 指令來擷取 ETag。

範例

ibmcloud hpcs uko managed-key-deactivate \
  --id=21a7498e-2ae4-47ee-85ac-a19bf64e92fa \
  --if-match=2022-05-27T10:13:31Z \
  --output json

輸出

標頭:

表格。指令輸出標頭
名稱	類型	說明
X-相關性-ID	字串	附加至容許參照特定交易或事件鏈的要求及訊息的唯一 ID。
ETag	字串	資源特定版本的 ID。

指令會傳回類似下列範例的輸出:

{
  "id": "ceb54688-827c-4e31-afa8-4c0122465a5b",
  "vault": {
    "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
    "name": "AWS-EXAMPLE-VAULT",
    "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
  },
  "template": {
    "id": "7a4e3659-083b-4d77-8562-7081eb197e90",
    "name": "AWS-EXAMPLE-TEMPLATE",
    "type": [
      "user_defined"
    ],
    "href": "/v4/templates/7a4e3659-083b-4d77-8562-7081eb197e90"
  },
  "version": 1,
  "description": "AWS key template description",
  "label": "AWS-production-2029",
  "state": "active",
  "size": 256,
  "algorithm": "aes",
  "verification_patterns": [
    {
      "method\"": "ENC-ZERO",
      "value": "C05CA1"
    }
  ],
  "activation_date": "2028-07-14",
  "expiration_date": "2029-09-25",
  "label_tags": [
    {
      "name": "APP",
      "value": "AWS"
    },
    {
      "name": "ENV",
      "value": "production"
    },
    {
      "name": "lay",
      "value": "2029"
    }
  ],
  "tags": [
    {
      "name": "TAG-1",
      "value": "AWS-TAG"
    }
  ],
  "created_at": "2023-06-05T10:40:13Z",
  "updated_at": "2023-06-05T10:40:19Z",
  "created_by": "IBMid-665000MCAR",
  "updated_by": "IBMid-665000MCAR",
  "referenced_keystores": [
    {
      "id": "0743ae15-c594-476d-8e9a-1564740ace53",
      "name": "AWS KMS Keystore 335",
      "type": "aws_kms",
      "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
    }
  ],
  "instances": [
    {
      "id": "8c2bef79-dd15-477c-93f0-0ae62264d4b6",
      "label_in_keystore": "AWS-production-2029",
      "type": "secret_key",
      "keystore": {
        "group\"": "Production-AWS-DE",
        "type\"": "aws_kms"
      }
    }
  ],
  "href": "/v4/managed_keys/ceb54688-827c-4e31-afa8-4c0122465a5b",
  "status_in_keystores": [
    {
      "keystore": {
        "id": "0743ae15-c594-476d-8e9a-1564740ace53",
        "name": "AWS KMS Keystore 335",
        "type": "aws_kms",
        "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
      },
      "status": "active",
      "keystore_sync_flag": "ok",
      "keystore_sync_flag_detail": "active_key_is_active_in_keystore",
      "key_id_in_keystore": "arn:aws:kms:eu-central-1:584492040385:key/52eca0ad-79ca-4c16-8934-986ac5d14b73"
    }
  ]
}

hpcs uko managed-key-destroy

毀損受管理金鑰，並對與受管理金鑰相關聯之金鑰儲存庫群組中的金鑰儲存庫執行金鑰毀損作業。此作業無法復原。在執行此指令之前，請確定受管理金鑰處於 deactivated 狀態。

ibmcloud hpcs uko managed-key-destroy --id ID --if-match IF-MATCH

指令選項

-- id (字串)

必要。金鑰的 UUID。您可以使用 ibmcloud hpcs uko managed-keys 指令來擷取金鑰 UUID。

-- if-match (string)

必要。更新的前置條件，這是 GET 要求標頭中的 ETag 值。您可以使用 ibmcloud hpcs uko managed-key 指令來擷取 ETag。

範例

ibmcloud hpcs uko managed-key-destroy \
  --id=21a7498e-2ae4-47ee-85ac-a19bf64e92fa \
  --if-match=2022-05-27T10:14:13Z \
  --output json

輸出

標頭:

表格。指令輸出標頭
名稱	類型	說明
X-相關性-ID	字串	附加至容許參照特定交易或事件鏈的要求及訊息的唯一 ID。
ETag	字串	資源特定版本的 ID。

指令會傳回類似下列範例的輸出:

{
  "id": "ceb54688-827c-4e31-afa8-4c0122465a5b",
  "vault": {
    "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
    "name": "AWS-EXAMPLE-VAULT",
    "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
  },
  "template": {
    "id": "7a4e3659-083b-4d77-8562-7081eb197e90",
    "name": "AWS-EXAMPLE-TEMPLATE",
    "type": [
      "user_defined"
    ],
    "href": "/v4/templates/7a4e3659-083b-4d77-8562-7081eb197e90"
  },
  "version": 1,
  "description": "AWS key template description",
  "label": "AWS-production-2029",
  "state": "active",
  "size": 256,
  "algorithm": "aes",
  "verification_patterns": [
    {
      "method\"": "ENC-ZERO",
      "value": "C05CA1"
    }
  ],
  "activation_date": "2028-07-14",
  "expiration_date": "2029-09-25",
  "label_tags": [
    {
      "name": "APP",
      "value": "AWS"
    },
    {
      "name": "ENV",
      "value": "production"
    },
    {
      "name": "lay",
      "value": "2029"
    }
  ],
  "tags": [
    {
      "name": "TAG-1",
      "value": "AWS-TAG"
    }
  ],
  "created_at": "2023-06-05T10:40:13Z",
  "updated_at": "2023-06-05T10:40:19Z",
  "created_by": "IBMid-665000MCAR",
  "updated_by": "IBMid-665000MCAR",
  "referenced_keystores": [
    {
      "id": "0743ae15-c594-476d-8e9a-1564740ace53",
      "name": "AWS KMS Keystore 335",
      "type": "aws_kms",
      "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
    }
  ],
  "instances": [
    {
      "id": "8c2bef79-dd15-477c-93f0-0ae62264d4b6",
      "label_in_keystore": "AWS-production-2029",
      "type": "secret_key",
      "keystore": {
        "group\"": "Production-AWS-DE",
        "type\"": "aws_kms"
      }
    }
  ],
  "href": "/v4/managed_keys/ceb54688-827c-4e31-afa8-4c0122465a5b",
  "status_in_keystores": [
    {
      "keystore": {
        "id": "0743ae15-c594-476d-8e9a-1564740ace53",
        "name": "AWS KMS Keystore 335",
        "type": "aws_kms",
        "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
      },
      "status": "active",
      "keystore_sync_flag": "ok",
      "keystore_sync_flag_detail": "active_key_is_active_in_keystore",
      "key_id_in_keystore": "arn:aws:kms:eu-central-1:584492040385:key/52eca0ad-79ca-4c16-8934-986ac5d14b73"
    }
  ]
}

hpcs uko managed-key-sync

在受管理金鑰上執行同步化作業，以對齊相關聯金鑰儲存庫中的狀態。

ibmcloud hpcs uko managed-key-sync --id ID --if-match IF-MATCH

指令選項

-- id (字串)

必要。金鑰的 UUID。您可以使用 ibmcloud hpcs uko managed-keys 指令來擷取金鑰 UUID。

-- if-match (string)

必要。更新的前置條件，這是 GET 要求標頭中的 ETag 值。您可以使用 ibmcloud hpcs uko managed-key 指令來擷取 ETag。

範例

ibmcloud hpcs uko managed-key-sync \
    --id=b28bf13d-f49d-4b00-8b8d-457d38ad1e15 \
    --if-match=2022-05-27T10:14:13Z \
    --output json

輸出

標頭:

表格。指令輸出標頭
名稱	類型	說明
X-相關性-ID	字串	附加至容許參照特定交易或事件鏈的要求及訊息的唯一 ID。

指令會傳回類似下列範例的輸出:

{
  "status_in_keystores": [
    {
      "keystore": {
        "id": "b28bf13d-f49d-4b00-8b8d-457d38ad1e15",
        "name": "AWS KMS Keystore Name",
        "type": "aws_kms",
        "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/keystores/b28bf13d-f49d-4b00-8b8d-457d38ad1e15"
      },
      "status": "not_present"
    }
  ]
}

hpcs uko key-templates

列出實例中的所有金鑰範本。

如果未設定 --all-pages 選項，則指令只會擷取集合的單一頁面。

ibmcloud hpcs uko key-templates [--name NAME] [--naming-scheme NAME-SCHEME] [--vault-id VAULT-ID] [--key-algorithm KEY-ALGORITHM] [--key-size KEY-SIZE] [--key-size-min KEY-SIZE-MIN] [--key-size-max KEY-SIZE-MAX] [--keystores-type KEYSTORES-TYPE] [--keystores-group KEYSTORES-GROUP] [--created-at CREATED-AT] [--created-at-min CREATED-AT-MIN] [--created-at-max CREATED-AT-MAX] [--updated-at UPDATED-AT] [--updated-at-min UPDATED-AT-MIN] [--updated-at-max UPDATED-AT-MAX] [--type TYPE] [--state STATE] [--sort SORT] [--limit LIMIT] [--offset OFFSET] [--managing-systems MANAGING-SYSTEMS]

指令選項

-- name (字串)

選用。只傳回名稱以字串開頭的範本。

-- naming-scheme (string)

選用。只傳回其命名方法包含字串的範本。

-- vault-id (字串)

選用。儲存庫的 UUID。長度必須為 36 個字元。該值必須符合正規表示式 /^[-0-9a-z]+$/。

-- key-algorithm (string)

選用。所傳回金鑰範本的演算法。可以設定的值為 aes、rsa、hmac、ec、des 及 dilithium。

-- key-size (字串)

選用。金鑰的大小

--key-size-min (字串)

選用。金鑰的大小下限。此查詢參數無法與 key-size 查詢參數一起使用。

--key-size-max (字串)

選用。金鑰的大小上限。此查詢參數無法與 key-size 查詢參數一起使用。

-- keystores-type ([]字串)

選用。所參照金鑰儲存庫的類型。可以設定的值為 aws_kms、azure_key_vault、ibm_cloud_kms、google_kms 及 cca。

-- keystores-group ([]string)

選用。所參照金鑰儲存庫的群組。

-- created-at (字串)

選用。只傳回其建立時間符合參數的受管理金鑰。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

--created-at-min (字串)

選用。只傳回其建立時間等於或晚於參數值的受管理金鑰。此查詢參數無法與 created_at 查詢參數一起使用。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

--created-at-max (字串)

選用。只傳回其建立時間等於或早於參數值的受管理金鑰。此查詢參數無法與 created_at 查詢參數一起使用。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

-- updated-at (字串)

選用。只傳回更新時間符合參數的受管理金鑰。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

--updated-at-min (字串)

選用。只傳回更新時間在參數值之後的受管理金鑰。此查詢參數無法與 updated_at 查詢參數一起使用。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

--updated-at-max (字串)

選用。只傳回更新時間早於參數值的受管理金鑰。此查詢參數無法與 updated_at 查詢參數一起使用。值必須符合正規表示式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/。

-- type ([]string)

選用。所傳回範本的類型。可以設定值為 user_defined、shadow 和 system。

-- state ([]string)

選用。只傳回其狀態包含字串的範本。可以設定的值為 archived 或 unarchived。

-- sort ([]字串)

選用。排序順序。預設值為 ["-updated_at"]。清單項目必須符合正規表示式 /^-?[a-z0-9_.\\[\\],-]+$/。

-- limit (int64)

選用。要擷取的金鑰範本數目。值必須介於 1 和 1000 之間。

-- offset (int64)

選用。要跳過的金鑰數目。最小值為 0。

-- managing-systems

僅傳回具有給定管理系統的受管理金鑰。可以設定的值為 web 和 workstation。

範例

ibmcloud hpcs uko key-templates --output json

輸出

標頭:

表格。指令輸出標頭
名稱	類型	說明
X-相關性-ID	字串	附加至容許參照特定交易或事件鏈的要求及訊息的唯一 ID。

指令會傳回類似下列範例的輸出:

{
  "total_count": 3,
  "limit": 20,
  "offset": 0,
  "first": {
    "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/templates?vault.id=5295ad47-2ce9-43c3-b9e7-e5a9482c362b&limit=20"
  },
  "last": {
    "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/templates?vault.id=5295ad47-2ce9-43c3-b9e7-e5a9482c362b&limit=20&offset=0"
  },
  "templates": [
    {
      "vault": {
        "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
        "name": "VAULT 391",
        "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
      },
      "id": "91caa113-d3ba-4620-a252-1c27aa31fd4e",
      "version": "0",
      "name": "AWS-TEMPLATE-229",
      "naming_scheme": "<APP>-AES256-<ENV>-<GROUP>-<lay>",
      "type": [
        "user_defined"
      ],
      "state": "unarchived",
      "keys_count": "0",
      "key": {
        "size": "256",
        "algorithm": "aes",
        "activation_date": "P5Y1M1W2D",
        "expiration_date": "P1Y2M1W4D",
        "state": "active"
      },
      "description": "AWS KMS KEY TEMPLATE",
      "created_at": "2023-06-05T14:16:07Z",
      "updated_at": "2023-06-05T14:16:07Z",
      "created_by": "IBMid-665000MCAR",
      "updated_by": "IBMid-665000MCAR",
      "keystores": [
        {
          "group": "Production-AWS-DE",
          "type": "aws_kms"
        }
      ],
      "href": "v4/templates/91caa113-d3ba-4620-a252-1c27aa31fd4e"
    },
    {
      "vault": {
        "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
        "name": "Vault 391",
        "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
      },
      "id": "64f98479-392d-4af2-a076-77cc21b8c6f3",
      "version": "0",
      "name": "IBM-template-371",
      "naming_scheme": "IBMCloud<APP><ENV><lay>",
      "type": [
        "user_defined"
      ],
      "state": "unarchived",
      "keys_count": "0",
      "key": {
        "size": "256",
        "algorithm": "aes",
        "activation_date": "P5Y1M1W2D",
        "expiration_date": "P1Y2M1W4D",
        "state": "active"
      },
      "description": "IBM CLOUD key template description",
      "created_at": "2023-06-05T11:59:08Z",
      "updated_at": "2023-06-05T11:59:08Z",
      "created_by": "IBMid-665000MCAR",
      "updated_by": "IBMid-665000MCAR",
      "keystores": [
        {
          "group": "Production External GB",
          "type": "ibm_cloud_kms"
        }
      ],
      "href": "/v4/templates/64f98479-392d-4af2-a076-77cc21b8c6f3"
    },
    {
      "vault": {
        "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
        "name": "Vault 391",
        "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
      },
      "id": "6393e930-562c-4042-b324-45c37d3d49d9",
      "version": "0",
      "name": "AZURE-TEMPLATE-920",
      "naming_scheme": "<APP><ENV><lay>",
      "type": [
        "user_defined"
      ],
      "state": "unarchived",
      "keys_count": "0",
      "key": {
        "size": "2048",
        "algorithm": "rsa",
        "activation_date": "P5Y1M1W2D",
        "expiration_date": "P1Y2M1W4D",
        "state": "active"
      },
      "description": "AZURE MANAGED KEY",
      "created_at": "2023-06-05T11:33:24Z",
      "updated_at": "2023-06-05T11:33:24Z",
      "created_by": "IBMid-665000MCAR",
      "updated_by": "IBMid-665000MCAR",
      "keystores": [
        {
          "group": "Production AZURE GB",
          "type": "azure_key_vault",
          "azure_key_protection_level": "software"
        }
      ],
      "href": "/v4/templates/6393e930-562c-4042-b324-45c37d3d49d9"
    },
    {
      "vault": {
        "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
        "name": "Vault 391",
        "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
      },
      "id": "09d229e5-e330-4e85-a7ee-cc8555d38603",
      "version": "0",
      "name": "GOOGLE-TEMPLATE-86",
      "naming_scheme": "<APP>-<ENV>-<lay>",
      "type": [
        "user_defined"
      ],
      "state": "unarchived",
      "keys_count": "0",
      "key": {
        "size": "256",
        "algorithm": "aes",
        "activation_date": "P5Y1M1W2D",
        "expiration_date": "P1Y2M1W4D",
        "state": "active"
      },
      "description": "Google Key Template",
      "created_at": "2023-06-05T13:17:01Z",
      "updated_at": "2023-06-05T13:17:01Z",
      "created_by": "IBMid-665000MCAR",
      "updated_by": "IBMid-665000MCAR",
      "keystores": [
        {
          "group": "Production Google",
          "type": "google_kms",
          "google_key_protection_level": "software",
          "google_key_purpose": "encrypt_decrypt",
          "google_kms_algorithm": "google_symmetric_encryption"
        }
      ],
      "href": "/v4/templates/09d229e5-e330-4e85-a7ee-cc8555d38603"
    }
  ]
}

ibmcloud hpcs uko key-template-create

建立新的金鑰範本。金鑰範本用來結合建立金鑰所需的資訊。使用金鑰範本，您可以輕鬆建立後續金鑰，而無需指定任何詳細資料。

ibmcloud hpcs uko key-template-create --vault VAULT --name NAME --type TYPE --state STATE --naming-scheme NAMEING-SCHEME --key KEY --keystores KEYSTORES [--description DESCRIPTION]

指令選項

-- vault (VaultReferenceInCreationRequest)

必要。要在其中建立金鑰範本的儲存庫 ID。

-- name (字串)

必要。範本的名稱。您需要在建立受管理金鑰時參照它。長度必須介於 1 到 30 個字元之間。該值必須符合正規表示式 /^[A-Za-z][A-Za-z0-9-]*$/。

-- type (string[])

必要。範本的類型。可以設定的值為 user_defined、shadow 和 system。

-- state (string)

必要。範本的狀態。可以設定的值為 archived 或 unarchived。

-- naming-scheme (string)

必要。範本名稱需要遵循的字串型樣。

-- key (KeyProperties)

必要。說明受管理金鑰的內容。

-- keystores (KeystoresPropertiesCreate [])

必要。說明受管理金鑰要安裝在其中的金鑰儲存庫類型和群組的陣列。長度上限為 1 個項目。長度下限為 1 個項目。

--description (字串)

選用。金鑰範本的說明。長度必須介於 0 到 200 個字元之間。該值必須符合正規表示式 /(.|\\n)*/。

範例

ibmcloud hpcs uko key-template-create \
    --vault='{"id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b"}' \
    --name=IBM-CLOUD-EXAMPLE-TEMPLATE \
    --key='{"size": "256", "algorithm": "aes", "activation_date": "P5Y1M1W2D", "expiration_date": "P1Y2M1W4D", "state": "active"}' \
    --keystores='[{"group": "Production", "type": "ibm_cloud_kms"}]' \
    --state="unarchived" \
    --naming-scheme="A-<APP>-AES256-<ENV>-<GROUP>" \
    --type="user_defined" \
    --description="IBM CLOUD key template description" \
    --output json

輸出

標頭:

表格。指令輸出標頭
名稱	類型	說明
X-相關性-ID	字串	附加至容許參照特定交易或事件鏈的要求及訊息的唯一 ID。
位置	字串	新建立資源的路徑 (相對於環境定義根目錄)。
ETag	字串	資源特定版本的 ID。

指令會傳回類似下列範例的輸出:

{
  "vault": {
    "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
    "name": "VAULT 391",
    "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
  },
  "id": "91caa113-d3ba-4620-a252-1c27aa31fd4e",
  "version": "0",
  "name": "AWS-TEMPLATE-229",
  "naming_scheme": "<APP>-AES256-<ENV>-<GROUP>-<lay>",
  "type": [
    "user_defined"
  ],
  "state": "unarchived",
  "keys_count": "0",
  "key": {
    "size": "256",
    "algorithm": "aes",
    "activation_date": "P5Y1M1W2D",
    "expiration_date": "P1Y2M1W4D",
    "state": "active"
  },
  "description": "AWS KMS KEY TEMPLATE",
  "created_at": "2023-06-05T14:16:07Z",
  "updated_at": "2023-06-05T14:16:07Z",
  "created_by": "IBMid-665000MCAR",
  "updated_by": "IBMid-665000MCAR",
  "keystores": [
    {
      "group": "Production-AWS-DE",
      "type": "aws_kms"
    }
  ],
  "href": "v4/templates/91caa113-d3ba-4620-a252-1c27aa31fd4e"
}

hpcs uko key-template-delete

從儲存庫中刪除金鑰範本。在執行此指令之前，請確定沒有任何受管理金鑰與金鑰範本相關聯。

ibmcloud hpcs uko key-template-delete --id ID --if-match IF-MATCH

指令選項

-- id (字串)

必要。範本的 UUID。您可以使用 ibmcloud hpcs uko key-templates 指令來擷取 UUID。

-- if-match (string)

必要。更新的前置條件，這是 GET 要求標頭中的 ETag 值。您可以使用 ibmcloud hpcs uko key-template 指令來擷取 ETag。

範例

ibmcloud hpcs uko key-template-delete \
    --id=07b62c12-75a2-46c9-9259-0cecde3985d2 \
    --if-match=2022-05-11T14:58:26Z

輸出

標頭:

表格。指令輸出標頭
名稱	類型	說明
X-相關性-ID	字串	附加至容許參照特定交易或事件鏈的要求及訊息的唯一 ID。

指令會傳回類似下列範例的輸出:

...
OK

ibmcloud hpcs uko key-template

透過指定 ID 來擷取金鑰範本及其詳細資料。

ibmcloud hpcs uko key-template --id ID

指令選項

-- id (字串)

必要。範本的 UUID。您可以使用 ibmcloud hpcs uko key-templates 指令來擷取 UUID。

範例

ibmcloud hpcs uko key-template \
    --id=07b62c12-75a2-46c9-9259-0cecde3985d2 \
    --output json

輸出

標頭:

表格。指令輸出標頭
名稱	類型	說明
X-相關性-ID	字串	附加至容許參照特定交易或事件鏈的要求及訊息的唯一 ID。
ETag	字串	資源特定版本的 ID。

指令會傳回類似下列範例的輸出:

{
  "vault": {
    "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
    "name": "VAULT 391",
    "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
  },
  "id": "91caa113-d3ba-4620-a252-1c27aa31fd4e",
  "version": "0",
  "name": "AWS-TEMPLATE-229",
  "naming_scheme": "<APP>-AES256-<ENV>-<GROUP>-<lay>",
  "type": [
    "user_defined"
  ],
  "state": "unarchived",
  "keys_count": "0",
  "key": {
    "size": "256",
    "algorithm": "aes",
    "activation_date": "P5Y1M1W2D",
    "expiration_date": "P1Y2M1W4D",
    "state": "active"
  },
  "description": "AWS KMS KEY TEMPLATE",
  "created_at": "2023-06-05T14:16:07Z",
  "updated_at": "2023-06-05T14:16:07Z",
  "created_by": "IBMid-665000MCAR",
  "updated_by": "IBMid-665000MCAR",
  "keystores": [
    {
      "group": "Production-AWS-DE",
      "type": "aws_kms"
    }
  ],
  "href": "v4/templates/91caa113-d3ba-4620-a252-1c27aa31fd4e"
}

hpcs uko key-template-update

更新金鑰範本的屬性。

ibmcloud hpcs uko key-template-update --id ID --if-match IF-MATCH [--keystores KEYSTORES] [--name NAME] [--description DESCRIPTION] [--key KEY]

指令選項

-- id (字串)

必要。範本的 UUID。您可以使用 ibmcloud hpcs uko key-templates 指令來擷取 UUID。

-- if-match (string)

必要。更新的前置條件，這是 GET 要求標頭中的 ETag 值。您可以使用 ibmcloud hpcs uko key-template 指令來擷取 ETag。

-- name (字串)

選用。更新的範本名稱。

-- keystores (KeystoresPropertiesUpdate [])

選用。說明要在其中安裝受管理金鑰的金鑰儲存庫類型及群組的陣列。長度上限為 1 個項目。長度下限為 1 個項目。

--description (字串)

選用。金鑰範本的更新說明。長度必須介於 0 到 200 個字元之間。該值必須符合正規表示式 /(.|\\n)*/。

-- key (KeyPropertiesUpdate)

選用。受管理金鑰的內容。

範例

ibmcloud hpcs uko key-template-update \
  --id=07b62c12-75a2-46c9-9259-0cecde3985d2 \
  --if-match=2022-05-11T14:58:26Z \
  --description="The update of the template" \
  --output json

輸出

標頭:

表格。指令輸出標頭
名稱	類型	說明
X-相關性-ID	字串	附加至容許參照特定交易或事件鏈的要求及訊息的唯一 ID。
ETag	字串	資源特定版本的 ID。

指令會傳回類似下列範例的輸出:

{
  "vault": {
    "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
    "name": "VAULT 391",
    "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
  },
  "id": "91caa113-d3ba-4620-a252-1c27aa31fd4e",
  "version": "0",
  "name": "AWS-TEMPLATE-229",
  "naming_scheme": "<APP>-AES256-<ENV>-<GROUP>-<lay>",
  "type": [
    "user_defined"
  ],
  "state": "unarchived",
  "keys_count": "0",
  "key": {
    "size": "256",
    "algorithm": "aes",
    "activation_date": "P5Y1M1W2D",
    "expiration_date": "P1Y2M1W4D",
    "state": "active"
  },
  "description": "AWS KMS KEY TEMPLATE",
  "created_at": "2023-06-05T14:16:07Z",
  "updated_at": "2023-06-05T14:16:07Z",
  "created_by": "IBMid-665000MCAR",
  "updated_by": "IBMid-665000MCAR",
  "keystores": [
    {
      "group": "Production-AWS-DE",
      "type": "aws_kms"
    }
  ],
  "href": "v4/templates/91caa113-d3ba-4620-a252-1c27aa31fd4e"
}

hpcs uko 金鑰儲存庫

列出實例中的所有金鑰儲存庫。

如果未設定 --all-pages 選項，則指令只會擷取集合的單一頁面。

ibmcloud hpcs uko keystores [--type TYPE] [--name NAME] [--description DESCRIPTION] [--group GROUP] [--groups GROUPS] [--vault-id VAULT-ID] [--location LOCATION] [--limit LIMIT] [--offset OFFSET] [--sort SORT]

指令選項

-- type ([]string)

選用。您要擷取的金鑰儲存庫類型。可以設定的值為: aws_kms、azure_key_vault、ibm_cloud_kms、google_kms 及 cca。

-- name (字串)

選用。只傳回其名稱包含字串的金鑰儲存庫。長度必須介於 1 到 100 個字元之間。值必須符合正規表示式 /.+/。

--description (字串)

選用。只傳回其說明包含字串的金鑰儲存庫。長度必須介於 1 到 200 個字元之間。值必須符合正規表示式 /.+/。

-- group (string)

選用。金鑰儲存庫群組。此查詢參數無法與 groups[] 查詢參數一起使用。

-- groups ([]字串)

選用。金鑰儲存庫群組。

-- vault-id ([]字串)

選用。儲存庫的 UUID。清單項目必須符合正規表示式 /^[-0-9a-z]+$/。

-- location (字串)

選用。金鑰儲存庫位置。

-- limit (int64)

選用。要擷取的金鑰儲存庫數目。值必須介於 1 和 1000 之間。

-- offset (int64)

選用。要跳過的金鑰數目。最小值為 0。

-- sort ([]字串)

選用。排序順序。預設值為 ["-updated_at"]。清單項目必須符合正規表示式 /^-?[a-z0-9_.\\[\\],-]+$/。

-- all-pages (bool)

選用。呼叫多個要求，以顯示金鑰儲存庫集合的所有頁面。

範例

ibmcloud hpcs uko keystores --output json

輸出

標頭:

表格。指令輸出標頭
名稱	類型	說明
X-相關性-ID	字串	附加至容許參照特定交易或事件鏈的要求及訊息的唯一 ID。

指令會傳回類似下列範例的輸出:

{
  "total_count": 3,
  "limit": 20,
  "offset": 0,
  "first": {
    "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/keystores?limit=20"
  },
  "last": {
    "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/keystores?limit=20&offset=0"
  },
  "keystores": [
    {
      "vault": {
        "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
        "name": "Test Vault Name",
        "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
      },
      "id": "5312861e-5b9b-4f40-9264-997afc2cd034",
      "name": "AWS KMS Keystore Name",
      "description": "AWS KMS keystore",
      "groups": [
        "Production-UK",
        "Production-DE"
      ],
      "type": "aws_kms",
      "created_at": "2022-03-09T10:59:44Z",
      "updated_at": "2022-03-09T10:59:44Z",
      "created_by": "IBMid-1308197YB4",
      "updated_by": "IBMid-1308197YB4",
      "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/keystores/5312861e-5b9b-4f40-9264-997afc2cd034",
      "aws_region": "eu_central_1",
      "aws_access_key_id": "",
      "aws_secret_access_key": ""
    },
    {
      "vault": {
        "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
        "name": "Test Vault Name",
        "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
      },
      "id": "314d0c9c-8808-47f0-829a-e63bdbb93854",
      "name": "Azure Keystore Name ",
      "description": "The AZURE keystore for testing.",
      "groups": [
        "Azure Keystore Name "
      ],
      "type": "azure_key_vault",
      "created_at": "2022-03-09T11:00:04Z",
      "updated_at": "2022-03-09T11:00:04Z",
      "created_by": "IBMid-1308197YB4",
      "updated_by": "IBMid-1308197YB4",
      "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/keystores/314d0c9c-8808-47f0-829a-e63bdbb93854",
      "azure_resource_group": "EKMF-Web-Tests",
      "azure_location": "europe_north",
      "azure_service_principal_client_id": "c8e8540f-4f15-4b6b-8862-3ccdb389e35d",
      "azure_service_principal_password": "***",
      "azure_tenant": "fcf67057-50c9-4ad4-98f3-ffca64add9e9",
      "azure_subscription_id": "a9867d9b-582f-42f3-9392-26856b06b808",
      "azure_environment": "azure"
    },
    {
      "vault": {
        "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
        "name": "Test Vault Name",
        "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
      },
      "id": "f6a5ccc1-7fc3-435e-9637-482e470ba8e8",
      "name": "IBM Keystore Name",
      "description": "The description of the created keystore.",
      "groups": [
        "IBM Keystore Name"
      ],
      "type": "ibm_cloud_kms",
      "created_at": "2022-03-09T11:00:11Z",
      "updated_at": "2022-03-09T11:00:11Z",
      "created_by": "IBMid-1308197YB4",
      "updated_by": "IBMid-1308197YB4",
      "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/keystores/f6a5ccc1-7fc3-435e-9637-482e470ba8e8",
      "ibm_api_endpoint": "https://us-south.kms.cloud.ibm.com",
      "ibm_iam_endpoint": "https://iam.bluemix.net/identity/token",
      "ibm_api_key": "",
      "ibm_instance_id": "d139ea58-a073-441b-ba4e-dcc8bae58be4",
      "ibm_variant": "hpcs",
      "ibm_key_ring": "IBM-Cloud-KMS-Internal"
    }
  ]
}

ibmcloud hpcs uko keystore-create

建立內部金鑰儲存庫或連接至所要求類型的外部金鑰儲存庫。如果使用 dry_run 查詢參數，則不會在資料庫中建立金鑰儲存庫，且只會執行測試來驗證連線資訊是否正確。可以依下列參數排序: name、created_at、updated_at、vault-id。

ibmcloud hpcs uko keystore-create --keystore-body KEYSTORE-BODY [--dry-run DRY-RUN]

指令選項

-- keystore-body (KeystoreCreation要求)

必要。您要建立或連接之金鑰儲存庫的內容。

--dry-run (bool)

選用。執行測試以驗證使用給定參數所建立的金鑰儲存庫是否可以順利與通訊。未在資料庫中建立任何金鑰儲存庫。預設值為 false。

範例

ibmcloud hpcs uko keystore-create \
    --keystore-body='{"type": "aws_kms", "vault": {"id": "75d0f626-44b0-4076-80cd-8cb9e485fe73"}, "name": "AWS KMS Keystore", "description": "AWS KMS Keystore", "groups": ["Production", "Production-DE"], "aws_access_key_id": "HSNGYJMKHGFFF", "aws_secret_access_key": "JHGSY766YUG67GFV", "aws_region": "eu_central_1"}' \
    --output json

輸出

標頭:

表格。指令輸出標頭
名稱	類型	說明
X-相關性-ID	字串	附加至容許參照特定交易或事件鏈的要求及訊息的唯一 ID。
位置	字串	新建立資源的路徑 (相對於環境定義根目錄)。
ETag	字串	資源特定版本的 ID。

指令會傳回類似下列範例的輸出:

{
  "vault": {
    "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
    "name": "Test Vault Name",
    "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
  },
  "id": "f6a5ccc1-7fc3-435e-9637-482e470ba8e8",
  "name": "IBM Keystore Name",
  "description": "The description of the created keystore.",
  "groups": [
    "IBM Keystore Name"
  ],
  "type": "ibm_cloud_kms",
  "created_at": "2022-03-09T11:00:11Z",
  "updated_at": "2022-03-09T11:00:11Z",
  "created_by": "IBMid-1308197YB4",
  "updated_by": "IBMid-1308197YB4",
  "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/keystores/f6a5ccc1-7fc3-435e-9637-482e470ba8e8",
  "ibm_api_endpoint": "https://us-south.kms.cloud.ibm.com",
  "ibm_iam_endpoint": "https://iam.bluemix.net/identity/token",
  "ibm_api_key": "",
  "ibm_instance_id": "d139ea58-a073-441b-ba4e-dcc8bae58be4",
  "ibm_variant": "hpcs",
  "ibm_key_ring": "IBM-Cloud-KMS-Internal"
}

hpcs uko keystore-刪除

刪除內部金鑰儲存庫或移除外部金鑰儲存庫的連線。移除連線之後，遠端平台上的外部金鑰儲存庫仍然存在。

ibmcloud hpcs uko keystore-delete --id ID --if-match IF-MATCH [--mode MODE]

指令選項

-- id (字串)

必要。金鑰儲存庫的 UUID。您可以使用 ibmcloud hpcs uko keystores 指令來擷取 UUID。

-- if-match (string)

必要。更新的前置條件，這是 GET 要求標頭中的 ETag 值。您可以使用 ibmcloud hpcs uko keystore 指令來擷取 ETag。

-- mode (string)

選用。切斷金鑰儲存庫連線的模式。可以設定值為 restrict、disconnect、deactivate 和 destroy。預設值為 restrict。

範例

ibmcloud hpcs uko keystore-delete \
    --id=0325e05e-2b25-4f13-85b2-2d7f85e54359 \
    --if-match=2022-05-11T14:58:26Z

輸出

標頭:

表格。指令輸出標頭
名稱	類型	說明
X-相關性-ID	字串	附加至容許參照特定交易或事件鏈的要求及訊息的唯一 ID。

指令會傳回類似下列範例的輸出:

...
OK

hpcs uko 金鑰儲存庫

透過指定 ID 來擷取目標內部金鑰儲存庫或外部金鑰儲存庫連線及其詳細資料。

ibmcloud hpcs uko keystore --id ID

指令選項

-- id (字串)

必要。金鑰儲存庫的 UUID。您可以使用 ibmcloud hpcs uko keystores 指令來擷取 UUID。

範例

ibmcloud hpcs uko keystore \
    --id=0325e05e-2b25-4f13-85b2-2d7f85e54359 \
    --output json

輸出

標頭:

表格。指令輸出標頭
名稱	類型	說明
X-相關性-ID	字串	附加至容許參照特定交易或事件鏈的要求及訊息的唯一 ID。
ETag	字串	資源特定版本的 ID。

指令會傳回類似下列範例的輸出:

{
  "vault": {
    "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
    "name": "Test Vault Name",
    "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
  },
  "id": "f6a5ccc1-7fc3-435e-9637-482e470ba8e8",
  "name": "IBM Keystore Name",
  "description": "The description of the created keystore.",
  "groups": [
    "IBM Keystore Name"
  ],
  "type": "ibm_cloud_kms",
  "created_at": "2022-03-09T11:00:11Z",
  "updated_at": "2022-03-09T11:00:11Z",
  "created_by": "IBMid-1308197YB4",
  "updated_by": "IBMid-1308197YB4",
  "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/keystores/f6a5ccc1-7fc3-435e-9637-482e470ba8e8",
  "ibm_api_endpoint": "https://us-south.kms.cloud.ibm.com",
  "ibm_iam_endpoint": "https://iam.bluemix.net/identity/token",
  "ibm_api_key": "",
  "ibm_instance_id": "d139ea58-a073-441b-ba4e-dcc8bae58be4",
  "ibm_variant": "hpcs",
  "ibm_key_ring": "IBM-Cloud-KMS-Internal"
}

ibmcloud hpcs uko keystore-update

更新內部金鑰儲存庫或外部金鑰儲存庫連線的屬性。

ibmcloud hpcs uko keystore-update --id ID --if-match IF-MATCH --keystore-body KEYSTORE-BODY

指令選項

-- id (字串)

必要。金鑰儲存庫的 UUID。您可以使用 ibmcloud hpcs uko keystores 指令來擷取 UUID。

-- if-match (string)

必要。更新的前置條件，這是 GET 要求標頭中的 ETag 值。您可以使用 ibmcloud hpcs uko keystore 指令來擷取 ETag。

-- keystore-body (KeystoreUpdate要求)

必要。您要更新的金鑰儲存庫內容。

範例

ibmcloud hpcs uko keystore-update \
    --id=0325e05e-2b25-4f13-85b2-2d7f85e54359 \
    --if-match=2022-05-11T14:58:26Z \
    --keystore-body='{"description": "Updated description", "keystore_type": "aws_kms"}' \
    --output json

輸出

標頭:

表格。指令輸出標頭
名稱	類型	說明
X-相關性-ID	字串	附加至容許參照特定交易或事件鏈的要求及訊息的唯一 ID。
ETag	字串	資源特定版本的 ID。

指令會傳回類似下列範例的輸出:

{
  "vault": {
    "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
    "name": "Test Vault Name",
    "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
  },
  "id": "f6a5ccc1-7fc3-435e-9637-482e470ba8e8",
  "name": "IBM Keystore Name",
  "description": "The description of the created keystore.",
  "groups": [
    "IBM Keystore Name"
  ],
  "type": "ibm_cloud_kms",
  "created_at": "2022-03-09T11:00:11Z",
  "updated_at": "2022-03-09T11:00:11Z",
  "created_by": "IBMid-1308197YB4",
  "updated_by": "IBMid-1308197YB4",
  "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/keystores/f6a5ccc1-7fc3-435e-9637-482e470ba8e8",
  "ibm_api_endpoint": "https://us-south.kms.cloud.ibm.com",
  "ibm_iam_endpoint": "https://iam.bluemix.net/identity/token",
  "ibm_api_key": "",
  "ibm_instance_id": "d139ea58-a073-441b-ba4e-dcc8bae58be4",
  "ibm_variant": "hpcs",
  "ibm_key_ring": "IBM-Cloud-KMS-Internal"
}

hpcs uko associated-resources-for-target-keystore

取得與在此金鑰儲存庫中啟動的所有金鑰相關聯的資源清單。

如果未設定 --all-pages 選項，則指令只會擷取集合的單一頁面。

ibmcloud hpcs uko associated-resources-for-target-keystore --id ID [--limit LIMIT] [--offset OFFSET] [--sort SORT]

指令選項

-- id (字串)

必要。金鑰儲存庫的 UUID。您可以使用 ibmcloud hpcs uko keystores 指令來擷取 UUID。

-- limit (int64)

選用。要擷取的資源數目。值必須介於 1 和 1000 之間。

-- offset (int64)

選用。要跳過的資源數目。最小值為 0。

-- sort ([]字串)

選用。排序順序。預設值為 ["name"]。清單項目必須符合正規表示式 /^-?[a-z0-9_.\\[\\],-]+$/。

-- all-pages (bool)

選用。呼叫多個要求，以顯示金鑰儲存庫相關聯資源之集合的所有頁面。

範例

ibmcloud hpcs uko associated-resources-for-target-keystore \
--id=93777bca-baef-4070-b9b5-a2e6079df1b4 \
--output json

輸出

標頭:

表格。指令輸出標頭
名稱	類型	說明
X-相關性-ID	字串	附加至容許參照特定交易或事件鏈的要求及訊息的唯一 ID。

指令會傳回類似下列範例的輸出:

{
  "total_count": 3,
  "limit": 20,
  "offset": 0,
  "first": {
    "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/managed_key/5295ad47-2ce9-43c3-b9e7-e5a9482c362b/associated_resources?limit=20"
  },
  "last": {
    "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/managed_key/5295ad47-2ce9-43c3-b9e7-e5a9482c362b/associated_resources?limit=20&offset=0"
  },
  "previous": {
    "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/managed_keys?offset=80"
  },
  "next": {
    "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/managed_keys?offset=120"
  },
  "associated_resources": [
    {
      "vault": {
        "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
        "name": "Test Vault Name",
        "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
      },
      "managed_key": {
        "id": "93777bca-baef-4070-b9b5-a2e6079df1b4",
        "name": "My Managed Key",
        "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/managed_keys/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
      },
      "referenced_keystore": {
        "id": "93777bca-baef-4070-b9b5-a2e6079df1b4",
        "name": "My Managed Key",
        "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/managed_keys/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
      },
      "key_id_in_keystore": "93777bca-baef-4070-b9b5-a2e6079df1b4",
      "type": "com_ibm_cloud_kms_registration",
      "com_ibm_cloud_kms_registration": {
        "prevents_key_deletion": false,
        "service_name": "cloud-object-storage",
        "service_instance_name": "Cloud Object Storage-7s",
        "crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/db995d8d9cc715cd99f13b0671d978b6:57da8e3a-a86d-4e01-b840-f22d36e6f23f:bucket:keyprotecttest",
        "description": "some description"
      }
    }
  ]
}

hpcs uko 金鑰儲存庫-狀態

擷取目標內部或外部金鑰儲存庫的狀態。

ibmcloud hpcs uko keystore-status --id ID

指令選項

-- id (字串)

必要。金鑰儲存庫的 UUID。您可以使用 ibmcloud hpcs uko keystores 指令來擷取 UUID。

範例

ibmcloud hpcs uko keystore-status \
    --id=0325e05e-2b25-4f13-85b2-2d7f85e54359 \
    --output json

輸出

標頭:

表格。指令輸出標頭
名稱	類型	說明
X-相關性-ID	字串	附加至容許參照特定交易或事件鏈的要求及訊息的唯一 ID。

指令會傳回類似下列範例的輸出:

{
  "last_heartbeat": "2022-01-26T00:56:01Z",
  "health_status": "ok",
  "message": "Ping executed successfully."
}

hpcs uko 儲存庫

列出實例中的所有儲存庫。

如果未設定 --all-pages 選項，則指令只會擷取集合的單一頁面。

ibmcloud hpcs uko vaults [--limit LIMIT] [--offset OFFSET] [--sort SORT] [--name NAME] [--description DESCRIPTION]

指令選項

-- limit (int64)

選用。要擷取的儲存庫數目。最大值為 1000。最小值為 1。

-- offset (int64)

選用。要跳過的儲存庫數目。最小值為 0。

-- sort ([]字串)

選用。排序順序。預設值為 ["-updated_at"]。清單項目必須符合正規表示式 /^-?[a-z0-9_.\\[\\],-]+$/。

-- name (字串)

選用。僅傳回名稱以字串開頭的儲存庫。長度必須介於 1 到 100 個字元之間。該值必須符合正規表示式 /.+/。

--description (字串)

選用。僅傳回其說明包含字串的儲存庫。長度必須介於 1 到 200 個字元之間。該值必須符合正規表示式 /.+/。

-- all-pages (bool)

選用。呼叫多個要求以顯示儲存庫集合的所有頁面。
範例
```
ibmcloud hpcs uko vaults --output json
```

輸出

標頭:

表格。指令輸出標頭
名稱	類型	說明
X-相關性-ID	字串	附加至容許參照特定交易或事件鏈的要求及訊息的唯一 ID。

指令會傳回類似下列範例的輸出:

{
  "total_count": 2,
  "limit": 20,
  "offset": 0,
  "first": {
    "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/vaults?limit=20&limit=20&offset=0"
  },
  "last": {
    "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/vaults?limit=20&limit=20&offset=0&offset=0"
  },
  "vaults": [
    {
      "id": "d0564770-1422-420c-945f-10803a2e24de",
      "name": "EXAMPLE_VAULT_NAME",
      "description": "API Test Vault description update.",
      "created_on": "2022-03-07T09:39:17Z",
      "updated_on": "2022-03-07T14:31:09Z",
      "created_by": "IBMid-1308197YB4",
      "updated_by": "IBMid-1308197YB4",
      "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/vaults/d0564770-1422-420c-945f-10803a2e24de"
    },
    {
      "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
      "name": "Test Vault Name",
      "description": "'Test Vault Name' description.",
      "created_at": "2022-03-09T10:57:43Z",
      "updated_at": "2022-03-09T10:57:43Z",
      "created_by": "IBMid-1308197YB4",
      "updated_by": "IBMid-1308197YB4",
      "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
    }
  ]
}

hpcs uko vault-create

在實例中建立具有指定名稱及說明的儲存庫。

ibmcloud hpcs uko vault-create --name NAME [--description DESCRIPTION]

指令選項

-- name (字串)

必要。要指派給儲存庫的人類可讀名稱。為了保護您的隱私權，請勿使用個人資料，例如您的名稱或位置。長度必須介於 1 到 100 個字元之間。該值必須符合正規表示式 /^[A-Za-z0-9#@!$%'_-][A-Za-z0-9#@!$% '_-]*$/。

--description (字串)

選用。儲存庫的說明。長度必須介於 0 到 200 個字元之間。該值必須符合正規表示式 /(.|\\n)*/。

範例

ibmcloud hpcs uko vault-create \
    --name='Example Vault' \
    --description='The description of the creating vault' \
    --output json

輸出

標頭:

表格。指令輸出標頭
名稱	類型	說明
X-相關性-ID	字串	附加至容許參照特定交易或事件鏈的要求及訊息的唯一 ID。
ETag	字串	資源特定版本的 ID。

指令會傳回類似下列範例的輸出:

{
  "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
  "name": "Test Vault Name",
  "description": "'Test Vault Name' description.",
  "created_at": "2022-03-09T10:57:43Z",
  "updated_at": "2022-03-09T10:57:43Z",
  "created_by": "IBMid-1308197YB4",
  "updated_by": "IBMid-1308197YB4",
  "recovery_key_label": "TEKMF.AES.RECOVERY.00001",
  "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
  "keys_count": 100,
  "key_templates_count": 10,
  "keystores_count": 0
}

hpcs uko vault-delete

從實例中刪除儲存庫。在執行此指令之前，請確定沒有金鑰或金鑰儲存庫連接至儲存庫。

ibmcloud hpcs uko vault-delete --id ID --if-match IF-MATCH

指令選項

-- id (字串)

必要。儲存庫的 UUID。您可以使用 ibmcloud hpcs uko vaults 指令來擷取 UUID。

-- if-match (string)

必要。更新的前置條件，這是 GET 要求標頭中的 ETag 值。您可以使用 ibmcloud hpcs uko vault 指令來擷取 ETag。

範例

ibmcloud hpcs uko vault-delete \
    --id=a88f6e06-c903-4b9f-8ee0-45bd817bf1b6 \
    --if-match=2022-05-11T14:58:26Z

輸出

標頭:

表格。指令輸出標頭
名稱	類型	說明
X-相關性-ID	字串	附加至容許參照特定交易或事件鏈的要求及訊息的唯一 ID。

指令會傳回類似下列範例的輸出:

...
OK

hpcs uko vault

透過指定 ID 來擷取儲存庫及其詳細資料。

ibmcloud hpcs uko vault --id ID

指令選項

-- id (字串)

必要。儲存庫的 UUID。您可以使用 ibmcloud hpcs uko vaults 指令來擷取 UUID。

範例

ibmcloud hpcs uko vault \
    --id=06ce6d7e-9edb-431b-8a96-e88e8a4b266b \
    --output json

輸出

標頭:

表格。指令輸出標頭
名稱	類型	說明
X-相關性-ID	字串	附加至容許參照特定交易或事件鏈的要求及訊息的唯一 ID。
ETag	字串	資源特定版本的 ID。

指令會傳回類似下列範例的輸出:

{
  "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
  "name": "Test Vault Name",
  "description": "'Test Vault Name' description.",
  "created_at": "2022-03-09T10:57:43Z",
  "updated_at": "2022-03-09T10:57:43Z",
  "created_by": "IBMid-1308197YB4",
  "updated_by": "IBMid-1308197YB4",
  "recovery_key_label": "TEKMF.AES.RECOVERY.00001",
  "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
  "keys_count": 100,
  "key_templates_count": 10,
  "keystores_count": 0
}

hpcs uko vault-update

更新儲存庫的屬性。

ibmcloud hpcs uko vault-update --id ID --if-match IF-MATCH [--name NAME] [--description DESCRIPTION]

指令選項

-- id (字串)

必要。儲存庫的 UUID。您可以使用 ibmcloud hpcs uko vaults 指令來擷取 UUID。

-- if-match (string)

必要。更新的前置條件，這是 GET 要求標頭中的 ETag 值。您可以使用 ibmcloud hpcs uko vault 指令來擷取 ETag。

-- name (字串)

選用。 vault.The 長度必須介於 1 到 100 個字元之間。該值必須符合正規表示式 /^[A-Za-z0-9#@!$%'_-][A-Za-z0-9#@!$% '_-]*$/。

--description (字串)

選用。已更新儲存庫的說明。長度必須介於 0 到 200 個字元之間。該值必須符合正規表示式 /(.|\\n)*/。

範例

ibmcloud hpcs uko vault-update \
  --id=06ce6d7e-9edb-431b-8a96-e88e8a4b266b \
  --if-match=2022-05-11T14:58:26Z \
  --description='Updated description of the vault' \
  --name="Jakub's Vault" \
  --output json

輸出

標頭:

表格。指令輸出標頭
名稱	類型	說明
X-相關性-ID	字串	附加至容許參照特定交易或事件鏈的要求及訊息的唯一 ID。
ETag	字串	資源特定版本的 ID。

指令會傳回類似下列範例的輸出:

{
  "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
  "name": "Test Vault Name",
  "description": "'Test Vault Name' description.",
  "created_at": "2022-03-09T10:57:43Z",
  "updated_at": "2022-03-09T10:57:43Z",
  "created_by": "IBMid-1308197YB4",
  "updated_by": "IBMid-1308197YB4",
  "recovery_key_label": "TEKMF.AES.RECOVERY.00001",
  "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
  "keys_count": 100,
  "key_templates_count": 10,
  "keystores_count": 0
}

Unified Key Orchestrator CLI 外掛程式指令綱目範例

下列綱目範例代表您需要針對部分指令選項指定的資料。這些範例顯示資料結構，並包含期望值類型的位置保留元值。當您執行指令時，請視需要將這些值取代為適用於您環境的值。

KeyProperties

下列範例顯示 KeyProperties 物件的格式。

{
  "size" : "256",
  "algorithm" : "aes",
  "activation_date" : "P5Y1M1W2D",
  "expiration_date" : "P1Y2M1W4D",
  "state" : "active"
}

KeyProperties更新

下列範例顯示 KeyPropertiesUpdate 物件的格式。

{
  "size" : "256",
  "activation_date" : "P5Y1M1W2D",
  "expiration_date" : "P1Y2M1W4D",
  "state" : "active"
}

KeystoreCreation要求

下列範例顯示 KeystoreCreationRequest 物件的格式。

{
  "name": "IBM Cloud Keystore",
  "description": "IBM Cloud Keystore description.",
  "groups": [
    "Production"
  ],
  "ibm_api_endpoint": "https://us-south.kms.cloud.ibm.com",
  "ibm_iam_endpoint": "https://iam.bluemix.net/identity/token",
  "ibm_api_key": "bxgstahGH8273662-HGD8765ghsvv-hsjbv786KJHV",
  "ibm_instance_id": "r64jshf0a4-jh87-8476-jks3-9752hgdvs",
  "vault": {
    "id": "75d0f626-44b0-4076-80cd-8cb9e485fe73"
  },
  "ibm_variant": "hpcs",
  "ibm_key_ring": "IBM-Cloud-KMS-Internal",
  "type": "ibm_cloud_kms"
}

KeystoreUpdate要求

下列範例顯示 KeystoreUpdateRequest 物件的格式。

{
  "name": "IBM Cloud Keystore",
  "description": "IBM Cloud Keystore description.",
  "groups": [
    "Production"
  ],
  "ibm_api_endpoint": "https://us-south.kms.cloud.ibm.com",
  "ibm_iam_endpoint": "https://iam.bluemix.net/identity/token",
  "ibm_api_key": "***",
  "ibm_instance_id": "c9e2e2d5-013a-409f-93cf-5393972263d7",
  "ibm_key_ring": "Key-Ring-1"
}

KeystoresProperties建立[]

下列範例顯示 KeystoresPropertiesCreate[] 物件的格式。


[ {
  "group" : "Production",
  "type" : "ibm_cloud_kms",
  "google_key_protection_level" : "software",
  "google_key_purpose" : "encrypt_decrypt",
  "google_kms_algorithm" : "google_symmetric_encryption"
} ]

KeystoresProperties更新[]

下列範例顯示 KeystoresPropertiesUpdate[] 物件的格式。

[ {
  "group" : "Production",
  "google_key_protection_level" : "software",
  "google_key_purpose" : "encrypt_decrypt",
  "google_kms_algorithm" : "google_symmetric_encryption"
} ]

標籤[]

下列範例顯示 Tag[] 物件的格式。

[ {
  "name" : "exampleString",
  "value" : "exampleString"
} ]

VaultReferenceInCreation要求

下列範例顯示 VaultReferenceInCreationRequest 物件的格式。

{
  "id" : "5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
}