密钥管理系统创建白盒密钥-白盒密钥相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： kms.tencentcloudapi.com 。

创建白盒密钥。密钥个数的上限为 50。

默认接口请求频率限制：100次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateWhiteBoxKey。
Version	是	String	公共参数，本接口取值：2019-01-18。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai 。
Alias	是	String	作为密钥更容易辨识，更容易被人看懂的别名，不可为空，1-60个字母数字 - _ 的组合，首字符必须为字母或者数字。Alias不可重复。示例值：test-lzcw
Algorithm	是	String	创建密钥所有的算法类型，支持的取值：AES_256,SM4 示例值：SM4
Description	否	String	密钥的描述，最大1024字节示例值：白盒测试
Tags.N	否	Array of Tag	标签列表示例值：[{"TagKey":"env","TagValue":"dev"}]

3. 输出参数

参数名称	类型	描述
EncryptKey	String	用于加密的密钥，base64编码示例值：AACAAAAAMjCKSiiyLyF9LdkbAh+E1D/+W8C3rXOT8OSNAApxUk71RZ719MOQyKSdVm/grpbPSSNf2ywtJQaycFmHjaDMSoMMfC0TILCtFi6fQBEax3U8
DecryptKey	String	用于解密的密钥，base64编码示例值：AACAAAAAMjCKSiiyLyF9LdkbAh+E1D/+W8C3rXOT8OSNAApxUk71RZ719MOQyKSdVm/grpbPSSNf2ywtJQaycFmHjaDMSoMMfC0TILCtF
KeyId	String	白盒密钥的全局唯一标识符示例值：6df3665b-9807-11ef-8d67-5254008ae90d
TagCode	Integer	标签操作的返回码. 0: 成功；1: 内部错误；2: 业务处理错误示例值：0
TagMsg	String	标签操作的返回信息示例值：ok
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建白盒密钥

输入示例

POST / HTTP/1.1
Host: kms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateWhiteBoxKey
<公共请求参数>

{
    "Alias": "test-lzcw2",
    "Description": "白盒测试",
    "Algorithm": "SM4"
}

输出示例

{
    "Response": {
        "DecryptKey": "AACAAAAA0/BswblZOBqsOJY/ST****x9scSvWUFbSG/tGBrMpzuCndKomu/Ig4/G",
        "EncryptKey": "AACAAAAA0/BswblZO****VTtExsaGx9scSvWUFbSG/tGBrMpzuCndKomu/Ig4/G",
        "KeyId": "9fe1e083-9807-11ef-8d67-5254008ae90d",
        "RequestId": "af2946f2-0a41-4d40-9e6e-b6e1e3eb5447",
        "TagCode": 0,
        "TagMsg": "no tags to save"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError	内部错误。
InvalidParameterValue	参数取值错误。
InvalidParameterValue.AliasAlreadyExists	别名已经存在。
InvalidParameterValue.InvalidAlias	别名格式错误。
InvalidParameterValue.TagKeysDuplicated	标签键重复。
InvalidParameterValue.TagsNotExisted	标签键或标签值不存在。
LimitExceeded.KeyLimitExceeded	创建的密钥个数超过限制。
ResourceUnavailable.NotPurchased	白盒密钥服务尚未开通。
UnauthorizedOperation	未授权操作。

创建白盒密钥

本页目录：