CreateClientKey - 建立應用身份憑證 -

介面說明

RAM 使用者或 RAM 角色調用該 OpenAPI 需要被授與權限策略詳情，請參見存取控制。
自建應用進行密碼運算操作、擷取憑據值前，需要通過應用身份憑證（ClientKey）訪問 KMS 執行個體。建立應用存取點 AAP 和身份憑證（ClientKey）的整體流程如下：
1. 建立網路控制規則：設定允許訪問 KMS 的私網 IP 或私網網段。更多資訊，請參見 CreateNetworkRule 。
2. 建立權限原則：設定允許應用訪問的密鑰和憑據，並綁定網路控制規則。更多資訊，請參見 CreatePolicy 。
3. 建立應用存取點：設定認證方式，並綁定權限原則。更多資訊，請參見 CreateApplicationAccessPoint 。
4. 建立應用身份憑證（ClientKey）：設定 ClientKey 的加密口令、有效期間，並綁定應用存取點。即本文介紹的內容。

注意事項

ClientKey 有使用到期日，到期後 KMS 將不允許整合該 Client Key 的應用訪問 KMS 執行個體，請您在 Client Key 到期前完成更換。建議您在更換完成後，在 KMS 刪除到期的 Client Key。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
AapName	string	是	綁定的應用存取點名稱。	aap_test
Password	string	是	Client Key 加密口令。 8~64 位元，支援數字、英文大小寫、特殊字元`~!@#$%^&*?_-`，且必須包含其中的兩種。	bcfefe15-46f0****
NotAfter	string	否	ClientKey 的有效期間結束時間。按照 ISO8601 標準表示，並使用 UTC 時間。格式為：YYYY-MM-DDThh:mm:ssZ。說明如果您未輸入 NotAfter，取值預設為 ClientKey 的建立時間加上 5 年。如果您輸入了 NotAfter，必須輸入 NotBefore。	2028-08-31T17:14:33Z
NotBefore	string	否	ClientKey 的有效期間起始時間。按照 ISO8601 標準表示，並使用 UTC 時間。格式為：YYYY-MM-DDThh:mm:ssZ。說明如果您未輸入 NotBefore，取值預設為 ClientKey 的建立時間。如果您輸入了 NotBefore，必須輸入 NotAfter。	2023-08-31T17:14:33Z

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	本次調用請求的 ID，是由阿里雲為該請求產生的唯一識別碼，可用於排查和定位問題。	2312e45f-b2fa-4c34-ad94-3eca50932916
ClientKeyId	string	ClientKey 的 ID。	KAAP.66abf237-63f6-4625-b8cf-47e1086e****
KeyAlgorithm	string	加密 ClientKey 私密金鑰內容的演算法。目前僅支援 RSA_2048。	RSA_2048
PrivateKeyData	string	ClientKey 的私密金鑰內容。	MIIJqwIBAzCCCXcGCSqGSIb3DQEHAaCCCWgEgglkMIIJYDCCBBcGCSqGSIb3DQEHBqCCBAgwgg******
NotBefore	string	ClientKey 的有效期間起始時間。	2023-08-31T17:14:33Z
NotAfter	string	ClientKey 的有效期間結束時間。	2028-08-31T17:14:33Z

樣本

正常返回樣本

JSON格式

{
  "RequestId": "2312e45f-b2fa-4c34-ad94-3eca50932916",
  "ClientKeyId": "KAAP.66abf237-63f6-4625-b8cf-47e1086e****",
  "KeyAlgorithm": "RSA_2048",
  "PrivateKeyData": "MIIJqwIBAzCCCXcGCSqGSIb3DQEHAaCCCWgEgglkMIIJYDCCBBcGCSqGSIb3DQEHBqCCBAgwgg******",
  "NotBefore": "2023-08-31T17:14:33Z",
  "NotAfter": "2028-08-31T17:14:33Z"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。