1. 接口描述
接口请求域名： kms.tencentcloudapi.com 。
本接口使用后量子密码算法密钥，可加密最多为4KB任意数据，可用于加密数据库密码，RSA Key，或其它较小的敏感信息。对于应用的数据加密，使用GenerateDataKey生成的DataKey进行本地数据的加解密操作。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：PostQuantumCryptoEncrypt。 |
| Version | 是 | String | 公共参数，本接口取值：2019-01-18。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| KeyId | 是 | String | 调用CreateKey生成的CMK全局唯一标识符 示例值：23e80852-1e38-11e9-b129-5cb9019b4b01 |
| PlainText | 是 | String | 被加密的明文数据，该字段必须使用base64编码，原文最大长度支持4K 示例值：testName |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| CiphertextBlob | String | 加密后的密文，base64编码。注意：本字段中打包了密文和密钥的相关信息，不是对明文的直接加密结果，只有将该字段作为PostQuantumCryptoDecrypt接口的输入参数，才可以解密出原文。 示例值：ss |
| KeyId | String | 加密使用的CMK的全局唯一标识 示例值：9999aed0-4956-11e9-bc70-5254005e86b4 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 使用后量子密码算法密钥进行数据加密
使用后量子密码算法密钥进行数据加密。
输入示例
POST / HTTP/1.1
Host: kms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: PostQuantumCryptoEncrypt
<公共请求参数>
{
"KeyId": "abc",
"PlainText": "abc"
}输出示例
{
"Response": {
"CiphertextBlob": "abc",
"KeyId": "abc",
"RequestId": "abc"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue.InvalidKeyId | KeyId不合法。 |
| InvalidParameterValue.InvalidPlaintext | Plaintext不合法。 |
| ResourceUnavailable.CmkArchived | CMK已存档。 |
| ResourceUnavailable.CmkDisabled | CMK已被禁用。 |
| ResourceUnavailable.CmkNotFound | CMK不存在。 |
| UnauthorizedOperation | 未授权操作。 |