创建一个应用身份凭证(ClientKey)。
接口说明
-
RAM 用户或 RAM 角色调用该 OpenAPI 需要被授予的权限策略详情,请参见访问控制。
-
自建应用进行密码运算操作、获取凭据值前,需要通过应用身份凭证(ClientKey)访问 KMS 实例。创建应用接入点 AAP 和身份凭证(ClientKey)的整体流程如下:
- 创建网络控制规则:设置允许访问 KMS 的私网 IP 或私网网段。更多信息,请参见 CreateNetworkRule 。
- 创建权限策略:设置允许应用访问的密钥和凭据,并绑定网络控制规则。更多信息,请参见 CreatePolicy 。
- 创建应用接入点:设置认证方式,并绑定权限策略。更多信息,请参见 CreateApplicationAccessPoint 。
- 创建应用身份凭证(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。 说明
| 2028-08-31T17:14:33Z |
NotBefore | string | 否 | ClientKey 的有效期起始时间。 按照 ISO8601 标准表示,并使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。 说明
| 2023-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"
}
错误码
访问错误中心查看更多错误码。