1. 接口描述
接口请求域名： kms.tencentcloudapi.com 。
展示白盒密钥的信息
默认接口请求频率限制：200次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeWhiteBoxKey。 |
| Version | 是 | String | 公共参数，本接口取值：2019-01-18。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai 。 |
| KeyId | 是 | String | 白盒密钥的全局唯一标识符 示例值：244dab8c-6dad-11ea-80c6-5254006d0810 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| KeyInfo | WhiteboxKeyInfo | 白盒密钥信息 示例值：{ "Algorithm": "SM4", "Alias": "lzc2", "CreateTime": 1725072007, "CreatorUin": 700001224419, "DecryptKey": "AACAAAAACMD5WLvPb4qY****+rt0t6Qgamj/FwS6qYFZWwp/M0wM00KwxUSp8P", "Description": "2", "DeviceFingerprintBind": false, "EncryptKey": "AACAAAAACMD5WLvPb4qYHL2QLISZdb8s3i*t0t6Qgamj/FwS6qYFZWwp/M0wM00KwxUSp8P", "KeyId": "5551ef2e-6742-11ef-8133-525400b2f623", "OwnerUin": 100000007998, "ResourceId": "creatorUin/700001224419/5551ef2e-6742-11ef-8133-525400b2f623", "Status": "Enabled" } |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 展示白盒密钥的信息
输入示例
POST / HTTP/1.1
Host: kms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeWhiteBoxKey
<公共请求参数>
{
"KeyId": "5551ef2e-6742-11ef-8133-525400b2f623"
}输出示例
{
"Response": {
"KeyInfo": {
"Algorithm": "SM4",
"Alias": "lzc2",
"CreateTime": 1725072007,
"CreatorUin": 700001224419,
"DecryptKey": "AACAAAAACMD5WLv****+rt0t6Qgamj/FwS6qYFZWwp/M0wM00KwxUSp8P",
"Description": "2",
"DeviceFingerprintBind": false,
"EncryptKey": "AACAAAAACMD5WLvPb4qY***rt0t6Qgamj/FwS6qYFZWwp/M0wM00KwxUSp8P",
"KeyId": "5551ef2e-6742-11ef-8133-525400b2f623",
"OwnerUin": 100000007998,
"ResourceId": "creatorUin/700001224419/5551ef2e-6742-11ef-8133-525400b2f623",
"Status": "Enabled"
},
"RequestId": "13b3e0ed-7d5e-4c6c-99ba-b334f02d7573"
}
}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.InvalidKeyId | KeyId不合法。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable.NotPurchased | 白盒密钥服务尚未开通。 |
| UnauthorizedOperation | 未授权操作。 |
