CreateClientKey
創(chuàng)建一個應(yīng)用身份憑證(ClientKey)。
使用說明
自建應(yīng)用進行密碼運算操作、獲取憑據(jù)值前,需要通過應(yīng)用身份憑證(ClientKey)訪問KMS實例。創(chuàng)建應(yīng)用接入點AAP和身份憑證(ClientKey)的整體流程如下:
1. 創(chuàng)建網(wǎng)絡(luò)控制規(guī)則:設(shè)置允許訪問KMS的私網(wǎng)IP或私網(wǎng)網(wǎng)段。更多信息,請參見CreateNetworkRule。
2. 創(chuàng)建權(quán)限策略:設(shè)置允許應(yīng)用訪問的密鑰和憑據(jù),并綁定網(wǎng)絡(luò)控制規(guī)則。更多信息,請參見CreatePolicy。
3. 創(chuàng)建應(yīng)用接入點:設(shè)置認(rèn)證方式,并綁定權(quán)限策略。更多信息,請參見CreateApplicationAccessPoint。
4. 創(chuàng)建應(yīng)用身份憑證(ClientKey):設(shè)置ClientKey的加密口令、有效期,并綁定應(yīng)用接入點。即本文介紹的內(nèi)容。
注意事項
ClientKey有使用期限,到期后KMS將不允許集成該Client Key的應(yīng)用訪問KMS實例,請您在Client Key到期前完成更換。建議您在更換完成后,在KMS刪除過期的Client Key。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數(shù)
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | CreateClientKey | 要執(zhí)行的操作。取值:CreateClientKey。 |
AapName | String | 是 | aap_test | 綁定的應(yīng)用接入點名稱。 |
Password | String | 是 | bcfefe15-46f0**** | Client Key加密口令。 8~64位,支持?jǐn)?shù)字、英文大小寫、特殊字符 |
NotAfter | String | 否 | 2028-08-31T17:14:33Z | ClientKey的有效期結(jié)束時間。 按照ISO8601標(biāo)準(zhǔn)表示,并使用UTC時間。格式為:YYYY-MM-DDThh:mm:ssZ。 說明
|
NotBefore | String | 否 | 2023-08-31T17:14:33Z | ClientKey的有效期起始時間。 按照ISO8601標(biāo)準(zhǔn)表示,并使用UTC時間。格式為:YYYY-MM-DDThh:mm:ssZ。 說明
|
返回數(shù)據(jù)
名稱 |
類型 |
示例值 |
描述 |
RequestId | String | 2312e45f-b2fa-4c34-ad94-3eca50932916 | 本次調(diào)用請求的ID,是由阿里云為該請求生成的唯一標(biāo)識符,可用于排查和定位問題。 |
ClientKeyId | String | KAAP.66abf237-63f6-4625-b8cf-47e1086e**** | ClientKey的ID。 |
KeyAlgorithm | String | RSA_2048 | 加密ClientKey私鑰內(nèi)容的算法。目前僅支持RSA_2048。 |
PrivateKeyData | String | MIIJqwIBAzCCCXcGCSqGSIb3DQEHAaCCCWgEgglkMIIJYDCCBBcGCSqGSIb3DQEHBqCCBAgwgg****** | ClientKey的私鑰內(nèi)容。 |
NotBefore | String | 2023-08-31T17:14:33Z | ClientKey的有效期起始時間。 |
NotAfter | String | 2028-08-31T17:14:33Z | ClientKey的有效期結(jié)束時間。 |
示例
請求示例
http(s)://[Endpoint]/?Action=CreateClientKey
&AapName=aap_test
&Password=bcfefe15-46f0****
&NotAfter=2028-08-31T17:14:33Z
&NotBefore=2023-08-31T17:14:33Z
&公共請求參數(shù)
正常返回示例
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"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。