生成非对称密钥对
最近更新时间: 2025-01-20 17:15:22
1. 接口描述
接口请求域名： kms.api3.fincloud.tencent.cn。
生成非对称密钥对
默认接口请求频率限制：100次/秒。
接口更新时间：2022-09-15 14:59:11。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：GenerateAsymmetricKeyPair |
| Version | 是 | 否 | String | 公共参数，本接口取值：2019-01-18 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| KeyId | 是 | 否 | String | CMK全局唯一标识符 |
| KeySpec | 是 | 否 | String | 指定生成非对称密钥对算法。支持：SM2 |
| EncryptionPublicKey | 否 | 否 | String | X509格式的pem类型公钥字符串， 支持 RSA2048 和 SM2 公钥， 用于对返回的明文私钥进行加密。 若为空，则不对明文密钥对加密。 |
| EncryptionAlgorithm | 否 | 否 | String | 非对称加密算法，配合 EncryptionPublicKey 对返回数据进行加密。 目前支持：SM2（C1C3C2）, SM2_C1C3C2_ASN1(返回SM2C1C3C2 ASN1格式密文)，RSAES_PKCS1_V1_5， RSAES_OAEP_SHA_1， RSAES_OAEP_SHA_256。 若为空，则默认为 SM2。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| KeyId | String | CMK的全局唯一标识 |
| PrivateKeyPlaintext | String | 若调用时未提供 EncryptionPublicKey，该字段值为P8格式PEM类型私钥明文。 若调用时提供了 EncryptionPublicKey，则该字段值为使用 EncryptionPublicKey 公钥对P8格式PEM类型私钥明文进行非对称加密后的 Base64 编码的密文。需在 Base64 解码后，使用用户上传的公钥对应的私钥进行进一步解密，以获取P8格式PEM类型私钥明文。 |
| PublicKeyPlaintext | String | P1格式PEM类型返回的明文公钥。 |
| PrivateKeyCiphertextBlob | String | 使用 CMK 加密私钥后的密文，用户需要自行保存该密文，KMS不托管生成的密钥对。可以通过Decrypt接口从密文中获取密钥明文。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | |
| ResourceUnavailable.CmkDisabled | |
| ResourceUnavailable.CmkNotFound | |
| InvalidParameterValue.InvalidKeyId | |
| InternalError | |
| UnauthorizedOperation |