1. 接口描述
接口请求域名: kms.tencentcloudapi.com 。
本接口使用后量子密码算法密钥,解密密文,并得到明文数据。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:PostQuantumCryptoDecrypt。 |
Version | 是 | String | 公共参数,本接口取值:2019-01-18。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
CiphertextBlob | 是 | String | 待解密的密文数据 示例值:Ade234dasdeEWdGVzdCUyMHBsYWlJJlIHL |
EncryptionPublicKey | 否 | String | PEM 格式公钥字符串,支持 RSA2048 和 SM2 公钥,用于对返回数据中的 Plaintext 值进行加密。若为空,则不对 Plaintext 值加密。 示例值:-----BEGIN PUBLIC KEY----- MFkwEwYHKoZIzj0CAQYI**VWhjH2dhziiH/NWCkk3FjIhjIwqjmnWhmUTg== -----END PUBLIC KEY----- |
EncryptionAlgorithm | 否 | String | 非对称加密算法,配合 EncryptionPublicKey 对返回数据进行加密。目前支持:SM2(以 C1C3C2 格式返回密文),SM2_C1C3C2_ASN1 (以 C1C3C2 ASN1 格式返回密文),RSAES_PKCS1_V1_5,RSAES_OAEP_SHA_1,RSAES_OAEP_SHA_256。若为空,则默认为 SM2。 示例值:SM2 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
KeyId | String | CMK的全局唯一标识 示例值:23e80852-1e38-11e9-b129-5cb9019b4b01 |
PlainText | String | 若调用时未提供 EncryptionPublicKey,该字段值为 Base64 编码的明文,需进行 Base64 解码以获取明文。 若调用时提供了 EncryptionPublicKey,则该字段值为使用 EncryptionPublicKey 公钥进行非对称加密后的 Base64 编码的密文。需在 Base64 解码后,使用用户上传的公钥对应的私钥进行进一步解密,以获取明文。 示例值:dGVzdCUyMHBsYWluJTIwdGV4dA== |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 使用后量子密码算法解密
使用后量子密码算法解密。
输入示例
POST / HTTP/1.1
Host: kms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: PostQuantumCryptoDecrypt
<公共请求参数>
{
"CiphertextBlob": "Ade234dasdeEWdGVzdCUyMHBsYWlJJlIHL",
"EncryptionPublicKey": "-----BEGIN PUBLIC KEY----- MFkwEwYHKoZIzj0CAQYI******VWhjH2dhziiH/NWCkk3FjIhjIwqjmnWhmUTg== -----END PUBLIC KEY----- ",
"EncryptionAlgorithm": "SM2"
}
输出示例
{
"Response": {
"KeyId": "23e80852-1e38-11e9-b129-5cb9019b4b01",
"PlainText": "dGVzdCUyMHBsYWluJTIwdGV4dA==",
"RequestId": "cc8f9b3c-620d-4a25-9fb5-decd94357bd8"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.EncryptionError | 加密操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue.InvalidCiphertext | 密文格式错误。 |
ResourceUnavailable.CmkDisabled | CMK已被禁用。 |
ResourceUnavailable.CmkNotFound | CMK不存在。 |
UnauthorizedOperation | 未授权操作。 |