1. 接口描述
接口请求域名： kms.tencentcloudapi.com 。
获取白盒密钥列表
默认接口请求频率限制：100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeWhiteBoxKeyDetails。 |
| Version | 是 | String | 公共参数，本接口取值：2019-01-18。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai 。 |
| KeyStatus | 否 | Integer | 过滤条件：密钥的状态，0：disabled，1：enabled 示例值：1 |
| Offset | 否 | Integer | 含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0 示例值：0 |
| Limit | 否 | Integer | 含义跟 SQL 查询的 Limit 一致，表示本次最多获取 Limit 个元素。缺省值为0, 表示不分页 示例值：10 |
| TagFilters.N | 否 | Array of TagFilter | 标签过滤条件 示例值：[{"TagKey":"env","TagValue":["dev"]}] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| KeyInfos | Array of WhiteboxKeyInfo | 白盒密钥信息列表。 示例值：[ { "Algorithm": "SM4", "Alias": "test", "CreateTime": 1730441467, "CreatorUin": 700001224419, "DecryptKey": "AACAAAAA3iht+5vrtKBnJIvNucskvES4RaZ/MS+wxhkUYnFjL6GMg4MLepB87QaA7zivBKc", "Description": "描述", "DeviceFingerprintBind": false, "EncryptKey": "AACAAAAA3iht+5vrtKBnOagzrjIdOM411JIvNucskvES4RaZ/MS+wxhkUYnFjL6GMg4MLepB87QaA7zivBKc", "KeyId": "14a9885b-9818-11ef-8d67-5254008ae90d", "OwnerUin": 100000007998, "ResourceId": "creatorUin/700001224419/14a9885b-9818-11ef-8d67-5254008ae90d", "Status": "Enabled" } ] |
| TotalCount | Integer | 白盒密钥总数。 示例值：4 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取白盒密钥列表
输入示例
POST / HTTP/1.1
Host: kms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeWhiteBoxKeyDetails
<公共请求参数>
{
"KeyStatus": 1,
"Offset": 0,
"Limit": 1,
"TagFilters": [
{
"TagKey": "env",
"TagValue": [
"dev"
]
}
]
}输出示例
{
"Response": {
"KeyInfos": [
{
"Algorithm": "SM4",
"Alias": "testKey1",
"CreateTime": 1730441467,
"CreatorUin": 700001224419,
"DecryptKey": "AACAAAAA3iht+5vrtKBnOagzrjeMFY8GZnRWIOgNcaKtY4RzWUmt0chcuELNIt6ZADmXSEdfndSWfAKizW1F4rnp2fncVQppWNlDjSwY6F/RcSCmU0/aDx3Yc2UIq/zM1jsLFX29CUBQD2a1pNzwepAl1A5HbxLYnrwVdB8Z364d9CyNd5YhVUKo4a8vmx0KA66SaLFSlzpWNZWAb+kZGrJDWMMRqLYigukAYDPsPYXMAb/MIoW5ywicGiY04vI59J1LVPezyMhi5ydTHuImNEcgYw2Tt07yG7LiDFVkWo5iCXXX9/zu+9eXdX93WGz20oDDBwpcFsKMk9tXvVhx7o9TCSgT7VERIQOWQKTH9iDb5RUyRPqPvyV1KEtbhTx/AlnkZEIdOM411JIvNucskvES4RaZ/MS+wxhkUYnFjL6GMg4MLepB87QaA7zivBKc",
"Description": "测试描述信息",
"DeviceFingerprintBind": false,
"EncryptKey": "AACAAAAA3iht+5vrtKBnOagzrjeMFY8GZnRWIOgNcaKtY4RzWUmt0chcuELNIt6ZADmXSEdfndSWfAKizW1F4rnp2fncVQppWNlDjSwY6F/RcSCmU0/aDx3Yc2UIq/zM1jsLFX29CUBQD2a1pNzwepAl1A5HbxLYnrwVdB8Z364d9CyNd5YhVUKo4a8vmx0KA66SaLFSlzpWNZWAb+kZGrJDWMMRqLYigukAYDPsPYXMAb/MIoW5ywicGiY04vI59J1LVPezyMhi5ydTHuImNEcgYw2Tt07yG7LiDFVkWo5iCXXX9/zu+9eXdX93WGz20oDDBwpcFsKMk9tXvVhx7o9TCSgT7VERIQOWQKTH9iDb5RUyRPqPvyV1KEtbhTx/AlnkZEIdOM411JIvNucskvES4RaZ/MS+wxhkUYnFjL6GMg4MLepB87QaA7zivBKc",
"KeyId": "14a9885b-9818-11ef-8d67-5254008ae90d",
"OwnerUin": 100000007998,
"ResourceId": "creatorUin/700001224419/14a9885b-9818-11ef-8d67-5254008ae90d",
"Status": "Enabled"
}
],
"RequestId": "052e4c07-795b-4aa1-8b8f-b968d3792dea",
"TotalCount": 4
}
}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 | 参数取值错误。 |
| ResourceUnavailable.NotPurchased | 白盒密钥服务尚未开通。 |
| UnauthorizedOperation | 未授权操作。 |
