密钥管理系统获取多个主密钥属性-密钥相关接口-API 中心-腾讯云

1. 接口描述

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

该接口用于批量获取主密钥属性信息。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

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

3. 输出参数

参数名称	类型	描述
KeyMetadatas	Array of KeyMetadata	返回的属性信息列表示例值：[ { "Alias": "test8-lzc", "CreateTime": 1730347170, "CreatorUin": 700001224419, "DeletionDate": 0, "Description": "test描述", "HsmClusterId": "", "KeyId": "87ff856e-973c-11ef-947b-525400d834e5", "KeyRotationEnabled": false, "KeyState": "Enabled", "KeyUsage": "ENCRYPT_DECRYPT", "LastRotateTime": 1730347170, "NextRotateTime": 1761883170, "Origin": "TENCENT_KMS", "Owner": "user", "ResourceId": "creatorUin/700001224419/87ff856e-973c-11ef-947b-525400d834e5", "RotateDays": 365, "Type": 4, "ValidTo": 0 } ]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取多个主密钥属性

获取多个主密钥属性。

输入示例

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

{
    "KeyIds": [
        "87ff856e-973c-11ef-947b-525400d834e5",
        "93866e69-9755-11ef-8e65-52540089bc41"
    ]
}

输出示例

{
    "Response": {
        "KeyMetadatas": [
            {
                "Alias": "test8-lzc",
                "CreateTime": 1730347170,
                "CreatorUin": 700001224419,
                "DeletionDate": 0,
                "Description": "test描述",
                "HsmClusterId": "cls-hsm-3dflmo9g",
                "KeyId": "87ff856e-973c-11ef-947b-525400d834e5",
                "KeyRotationEnabled": false,
                "KeyState": "Enabled",
                "KeyUsage": "ENCRYPT_DECRYPT",
                "NextRotateTime": 1761883170,
                "Origin": "TENCENT_KMS",
                "Owner": "user",
                "ResourceId": "creatorUin/700001224419/87ff856e-973c-11ef-947b-525400d834e5",
                "Type": 4,
                "ValidTo": 0
            },
            {
                "Alias": "test11-lzc",
                "CreateTime": 1730357927,
                "CreatorUin": 700001224419,
                "DeletionDate": 0,
                "Description": "倒入外部密钥",
                "HsmClusterId": "cls-hsm-3dflmo9g",
                "KeyId": "93866e69-9755-11ef-8e65-52540089bc41",
                "KeyRotationEnabled": false,
                "KeyState": "Enabled",
                "KeyUsage": "ENCRYPT_DECRYPT",
                "NextRotateTime": 1761893927,
                "Origin": "EXTERNAL",
                "Owner": "user",
                "ResourceId": "creatorUin/700001224419/93866e69-9755-11ef-8e65-52540089bc41",
                "Type": 4,
                "ValidTo": 0
            }
        ],
        "RequestId": "05278c40-eb6c-473d-a1e6-00a8177f9c6a"
    }
}

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	内部错误。
InvalidParameter	参数错误。
InvalidParameterValue.DuplicatedKeyId	KeyId重复。
InvalidParameterValue.InvalidKeyId	KeyId不合法。
ResourceUnavailable.CmkNotFound	CMK不存在。
UnauthorizedOperation	未授权操作。

获取多个主密钥属性

本页目录：