密钥管理系统获取数据密钥的详情列表

1. 接口描述

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

返回数据密钥属性信息列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeDataKeys。
Version	是	String	公共参数，本接口取值：2019-01-18。
Region	是	String	公共参数，详见产品支持的地域列表。
DataKeyIds.N	是	Array of String	查询DataKey的ID列表，批量查询一次最多支持100个DataKeyId 示例值：["87ff856e-973c-11ef-947b-525400d834e5"]

3. 输出参数

参数名称	类型	描述
DataKeyMetadatas	Array of DataKeyMetadata	返回数据密钥属性信息列表示例值： { "DataKeyName": "x", "CreateTime": xxx, "CreatorUin": xxx, "DeletionDate": 0, "Description": "x", "HsmClusterId": "cls-x-x","NumberOfBytes":32, "DataKeyId": "xxx", "KeyId": "xxx", "KeyState": "xxx", "Origin": "xxx","ResourceId": "creatorUin/xxx/xxx" }
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取数据密钥的详情列表示例

输入示例

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

{
    "DataKeyIds": [
        "7fe31abf-5018-11f0-b672-52540073b995",
        "8042dfcb-5018-11f0-b672-52540073b995"
    ]
}

输出示例

{
    "Response": {
        "DataKeyMetadatas": [
            {
                "CreateTime": 1750672660,
                "CreatorUin": 100000007998,
                "DataKeyId": "7fe31abf-5018-11f0-b672-52540073b995",
                "DataKeyName": "Test6331120",
                "DeletionDate": 0,
                "Description": "",
                "HsmClusterId": "",
                "KeyId": "0397abd8-4029-11f0-aa65-52540064acab",
                "KeyState": "Enabled",
                "NumberOfBytes": 32,
                "Origin": "EXTERNAL",
                "Owner": "user",
                "ResourceId": "creatorUin/100000007998/7fe31abf-5018-11f0-b672-52540073b995"
            },
            {
                "CreateTime": 1750672660,
                "CreatorUin": 100000007998,
                "DataKeyId": "8042dfcb-5018-11f0-b672-52540073b995",
                "DataKeyName": "miNAmDEc09znOK7jw9Yi3L9cmq8xk6z1",
                "DeletionDate": 0,
                "Description": "TestDateKey_01",
                "HsmClusterId": "",
                "KeyId": "0397abd8-4029-11f0-aa65-52540064acab",
                "KeyState": "Enabled",
                "NumberOfBytes": 1024,
                "Origin": "TENCENT_KMS",
                "Owner": "user",
                "ResourceId": "creatorUin/100000007998/8042dfcb-5018-11f0-b672-52540073b995"
            }
        ],
        "RequestId": "33c0c722-09e0-4f19-b16b-187a5898fd66"
    }
}

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.DuplicatedDataKeyId	存在重复的数据密钥ID
InvalidParameterValue.InvalidDataKeyId	不合法的数据密钥ID
InvalidParameterValue.InvalidKeyId	KeyId不合法。
ResourceUnavailable.DataKeyNotFound	数据密钥不存在

获取数据密钥的详情列表

本页目录：