获取主密钥列表详情

1. 接口描述

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

根据指定Offset和Limit获取主密钥列表详情。

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 获取主密钥列表详情

输入示例

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

{
    "Offset": 0,
    "Limit": 10,
    "Role": 0,
    "OrderType": 0,
    "KeyState": 0,
    "SearchKeyAlias": "Weijiali",
    "Origin": "TENCENT_KMS",
    "KeyUsage": "ALL",
    "TagFilters": [
        {
            "TagKey": "env",
            "TagValue": [
                "dev"
            ]
        }
    ],
    "HsmClusterId": "cls-hsm-3dflmo9g"
}

输出示例

{
    "Response": {
        "KeyMetadatas": [
            {
                "Alias": "Weijiali_test_000000005",
                "CreateTime": 1725354067,
                "CreatorUin": 700001028674,
                "DeletionDate": 0,
                "Description": "weijiali_test_00000000000005",
                "HsmClusterId": "cls-hsm-3dflmo9g",
                "KeyId": "0ed49d3e-69d3-11ef-9841-52540089bc41",
                "KeyRotationEnabled": false,
                "KeyState": "Enabled",
                "KeyUsage": "ASYMMETRIC_SIGN_VERIFY_SM2",
                "NextRotateTime": 1756890067,
                "Origin": "TENCENT_KMS",
                "Owner": "user",
                "ResourceId": "creatorUin/700001028674/0ed49d3e-69d3-11ef-9841-52540089bc41",
                "Type": 4,
                "ValidTo": 0
            },
            {
                "Alias": "Weijiali_test_00000000000004",
                "CreateTime": 1725354055,
                "CreatorUin": 700001028674,
                "DeletionDate": 0,
                "Description": "Weijiali_test_00000000000004",
                "HsmClusterId": "cls-hsm-3dflmo9g",
                "KeyId": "07ad2031-69d3-11ef-9841-52540089bc41",
                "KeyRotationEnabled": false,
                "KeyState": "Enabled",
                "KeyUsage": "ASYMMETRIC_DECRYPT_SM2",
                "NextRotateTime": 1756890055,
                "Origin": "TENCENT_KMS",
                "Owner": "user",
                "ResourceId": "creatorUin/700001028674/07ad2031-69d3-11ef-9841-52540089bc41",
                "Type": 4,
                "ValidTo": 0
            },
            {
                "Alias": "weijiali_test_00000000000003",
                "CreateTime": 1725354040,
                "CreatorUin": 700001028674,
                "DeletionDate": 0,
                "Description": "weijiali_test_00000000000003",
                "HsmClusterId": "cls-hsm-3dflmo9g",
                "KeyId": "fea98175-69d2-11ef-910d-525400d834e5",
                "KeyRotationEnabled": false,
                "KeyState": "Enabled",
                "KeyUsage": "ENCRYPT_DECRYPT",
                "NextRotateTime": 1756890040,
                "Origin": "TENCENT_KMS",
                "Owner": "user",
                "ResourceId": "creatorUin/700001028674/fea98175-69d2-11ef-910d-525400d834e5",
                "Type": 4,
                "ValidTo": 0
            }
        ],
        "RequestId": "57c12411-dd1a-4f3c-aaff-aec49a442b6c",
        "TotalCount": 3
    }
}

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. 错误码

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