1. 接口描述
接口请求域名: kms.tencentcloudapi.com 。
使用指定的RSA非对称密钥的私钥进行数据解密,密文必须是使用对应公钥加密的。处于Enabled 状态的非对称密钥才能进行解密操作。
默认接口请求频率限制:200次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:AsymmetricRsaDecrypt。 |
Version | 是 | String | 公共参数,本接口取值:2019-01-18。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
KeyId | 是 | String | CMK的唯一标识 示例值:554ef4b3-3071-11ea-a86a-5254006d0810 |
Ciphertext | 是 | String | 使用PublicKey加密的密文,Base64编码 示例值:vlnJ/RrQE0mXiHGoya/xpKQJHkd5ImvdXug306BreYL60Kb8ucqQ0eurf5mX/mKZDSTGr8FDVK8b4HOopj7xuDQIzegObtvK2VGbXSaihI/fNDkmoWcgBF/V91scYJtrkwoISnvqsxcl9NeAp+H2A6E3vTiDpQK5oVb3OTG39FoYEvfbRNfef+iukiRiqOL7VGSPmx1nThi6Cd4XGBFzB0tvtmP2SnZhZuzryj+jnHVAz2bIuYP8M4OJYkk5muuACWxLGLQj5sh2FqIpbzT4nti4fOD4ieHnf/qCw/9yyiWUED67oelFKaBJEWGq3PT7bGtH4Sxx8SKx2BCBsR95sA== |
Algorithm | 是 | String | 在使用公钥加密时对应的算法:当前支持RSAES_PKCS1_V1_5、RSAES_OAEP_SHA_1、RSAES_OAEP_SHA_256 示例值:RSAES_OAEP_SHA_256 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
KeyId | String | CMK的唯一标识 示例值:edf72a11-69d0-11ef-9841-52540089bc41 |
Plaintext | String | 解密后的明文,base64编码 示例值:dGVzdA== |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 非对称密钥RSA解密
输入示例
POST / HTTP/1.1
Host: kms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AsymmetricRsaDecrypt
<公共请求参数>
{
"KeyId": "edf72a11-69d0-11ef-9841-52540089bc41",
"Ciphertext": "vlnJ/RrQE0mXiHGoya/xpKQJHkd5ImvdXug306BreYL60Kb8ucqQ0eurf5mX/mKZDSTGr8FDVK8b4HOopj7xuDQIzegObtvK2VGbXSaihI/fNDkmoWcgBF/V91scYJtrkwoISnvqsxcl9NeAp+H2A6E3vTiDpQK5oVb3OTG39FoYEvfbRNfef+iukiRiqOL7VGSPmx1nThi6Cd4XGBFzB0tvtmP2SnZhZuzryj+jnHVAz2bIuYP8M4OJYkk5muuACWxLGLQj5sh2FqIpbzT4nti4fOD4ieHnf/qCw/9yyiWUED67oelFKaBJEWGq3PT7bGtH4Sxx8SKx2BCBsR95sA==",
"Algorithm": "RSAES_OAEP_SHA_256"
}
输出示例
{
"Response": {
"KeyId": "edf72a11-69d0-11ef-9841-52540089bc41",
"Plaintext": "dGVzdAo=",
"RequestId": "8e7c44ba-917c-4e85-a626-a07806e9b7c9"
}
}
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.DecryptError | 解密失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue.InvalidKeyId | KeyId不合法。 |
InvalidParameterValue.InvalidKeyUsage | KeyUsage参数错误。 |
ResourceUnavailable.CmkNotFound | CMK不存在。 |
ResourceUnavailable.CmkStateNotSupport | CMK 状态不支持该操作。 |
UnauthorizedOperation | 未授权操作。 |