全部产品
Search
文档中心

密钥管理服务:CreateClientKey

更新时间:Sep 08, 2023

创建一个应用身份凭证(ClientKey)。

使用说明

自建应用进行密码运算操作、获取凭据值前,需要通过应用身份凭证(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"
}

错误码

访问错误中心查看更多错误码。