CreateClientKey - - 阿里雲

使用說明

自建應用進行密碼運算操作、擷取憑據值前，需要通過應用身份憑證（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程式碼範例。

請求參數

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

返回資料

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

樣本

請求樣本

http(s)://[Endpoint]/?Action=CreateClientKey
&AapName=aap_test
&Password=bcfefe15-46f0****
&NotAfter=2028-08-31T17:14:33Z
&NotBefore=2023-08-31T17:14:33Z
&公用請求參數

正常返回樣本

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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"
}

錯誤碼

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