1. 接口描述
接口请求域名： kms.tencentcloudapi.com 。
使用白盒密钥进行加密
默认接口请求频率限制：100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：EncryptByWhiteBox。 |
| Version | 是 | String | 公共参数，本接口取值：2019-01-18。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai 。 |
| KeyId | 是 | String | 白盒密钥的全局唯一标识符 示例值：244dab8c-6dad-11ea-80c6-5254006d0810 |
| PlainText | 是 | String | 待加密的文本， base64编码，文本的原始长度最大不超过4KB 示例值：UGxhaW5UZXh0 |
| InitializationVector | 否 | String | 初始化向量，大小为 16 Bytes，加密算法会使用到, base64编码；如果不传，则由后端服务随机生成。用户需要自行保存该值，作为解密的参数。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| InitializationVector | String | 初始化向量，加密算法会使用到, base64编码。如果由调用方在入参中传入，则原样返回。如果调用方没有传入，则后端服务随机生成，并返回 示例值：BQbVImt3p_xr8VQebZaXGQ== |
| CipherText | String | 加密后的密文，base64编码 示例值：ZKHH2la4DpwlkwjANQ5hgw== |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 使用白盒密钥进行加密
输入示例
https://kms.tencentcloudapi.com/?Action=EncryptByWhiteBox
&KeyId=244dab8c-6dad-11ea-80c6-5254006d0810
&PlainText=UGxhaW5UZXh0
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "4b3be01e-117a-43f5-aa34-dd5034efe3dd",
"InitializationVector": "BQbVImt3p_xr8VQebZaXGQ==",
"CipherText": "ZKHH2la4DpwlkwjANQ5hgw=="
}
}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 | 内部错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.InvalidKeyId | KeyId不合法。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable.KeyDisabled | 密钥已被禁用。 |
| ResourceUnavailable.NotPurchased | 白盒密钥服务尚未开通。 |
| UnauthorizedOperation | 未授权操作。 |