1. 接口描述
接口请求域名： kms.tencentcloudapi.com 。
使用指定的SM2非对称密钥的私钥进行数据解密，密文必须是使用对应公钥加密的。处于Enabled 状态的非对称密钥才能进行解密操作。传入的密文的长度不能超过256字节。
默认接口请求频率限制：200次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：AsymmetricSm2Decrypt。 |
| Version | 是 | String | 公共参数，本接口取值：2019-01-18。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| KeyId | 是 | String | CMK的唯一标识 示例值：554ef4b3-3071-11ea-a86a-5254006d0810 |
| Ciphertext | 是 | String | 使用PublicKey加密的密文，Base64编码，原始密文格式需要为C1C3C2_ASN1。原始密文长度不能超过256字节。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| KeyId | String | CMK的唯一标识 示例值：554ef4b3-3071-11ea-a86a-5254006d0810 |
| Plaintext | String | 解密后的明文，base64编码 示例值：dGVzdA== |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 非对称密钥Sm2解密
输入示例
https://kms.tencentcloudapi.com/?Action=AsymmetricSm2Decrypt
&KeyId=554ef4b3-3071-11ea-a86a-5254006d0810
&Ciphertext=Fb0UICocErQgNEkYKJagtoKNed7DLeo5UkZzPJMyI94CfWh6yKHGgb/0PBHrCve2Avo4gJI5pJMWP3Aq5ggX0aunLv87UX+sgO1/3HXW+q4ARaiwZ9Q73RQuPg6qJ2Eg33uZ2Xjey3l+5yHiOdZYmCVePtKAsuhxzKw/sALTbGTYYnbJXnGKr3Yu7Hs0hCC1bOz0sNqd1IXdUyMtQtbDOV8NWg2ecdZPIOdbnrCKIQ4rpMUghjSFv3rSHo5VbpuOGPXqEZT4goou42psIXb03li3TXxFZMTAdxVMzpqEuTfRxiMPEqyPEHe6xG92vJX0FZfWU8Y5SxlfXp+mvBbAmw==
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "7c076c83-1402-41d8-8ce6-73a350a9eaf6",
"KeyId": "554ef4b3-3071-11ea-a86a-5254006d0810",
"Plaintext": "dGVzdA=="
}
}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 | 未授权操作。 |
| UnsupportedOperation.UnsupportedKeyUsageInCurrentRegion | 加密方式在当前region不支持。 |