密钥管理系统获取主密钥列表详情-密钥相关接口-API 中心-腾讯云

1. 接口描述

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

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

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ListKeyDetail。
Version	是	String	公共参数，本接口取值：2019-01-18。
Region	是	String	公共参数，详见产品支持的地域列表。
Offset	否	Integer	含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0 示例值：0
Limit	否	Integer	含义跟 SQL 查询的 Limit 一致，表示本次最多获取 Limit 个元素。缺省值为10，最大值为200 示例值：10
Role	否	Integer	根据创建者角色筛选，默认 0 表示用户自己创建的cmk， 1 表示授权其它云产品自动创建的cmk 示例值：0
OrderType	否	Integer	根据CMK创建时间排序， 0 表示按照降序排序，1表示按照升序排序示例值：0
KeyState	否	Integer	根据CMK状态筛选， 0表示全部CMK， 1 表示仅查询Enabled CMK， 2 表示仅查询Disabled CMK，3 表示查询PendingDelete 状态的CMK(处于计划删除状态的Key)，4 表示查询 PendingImport 状态的CMK，5 表示查询 Archived 状态的 CMK 示例值：0
SearchKeyAlias	否	String	根据KeyId或者Alias进行模糊匹配查询示例值：lzctest
Origin	否	String	根据CMK类型筛选， "TENCENT_KMS" 表示筛选密钥材料由KMS创建的CMK， "EXTERNAL" 表示筛选密钥材料需要用户导入的 EXTERNAL类型CMK，"ALL" 或者不设置表示两种类型都查询，大小写敏感。示例值：ALL
KeyUsage	否	String	根据CMK的KeyUsage筛选，ALL表示筛选全部，可使用的参数为：ALL 或 ENCRYPT_DECRYPT 或 ASYMMETRIC_DECRYPT_RSA_2048 或 ASYMMETRIC_DECRYPT_SM2 或 ASYMMETRIC_SIGN_VERIFY_SM2 或 ASYMMETRIC_SIGN_VERIFY_RSA_2048 或 ASYMMETRIC_SIGN_VERIFY_ECC，为空则默认筛选ENCRYPT_DECRYPT类型示例值：ASYMMETRIC_SIGN_VERIFY_RSA_2048
TagFilters.N	否	Array of TagFilter	标签过滤条件示例值：[{"TagKey":"env","TagValue":["dev"]}]
HsmClusterId	否	String	KMS 高级版对应的 HSM 集群 ID（仅对 KMS 独占版/托管版服务实例有效）。示例值：cls-hsm-3dflmo9g

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	CMK的总数量示例值：10
KeyMetadatas	Array of KeyMetadata	返回的属性信息列表。示例值：[ { "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", "LastRotateTime": 1725354067, "NextRotateTime": 1756890067, "Origin": "TENCENT_KMS", "Owner": "user", "ResourceId": "creatorUin/700001028674/0ed49d3e-69d3-11ef-9841-52540089bc41", "RotateDays": 365, "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", "LastRotateTime": 1725354055, "NextRotateTime": 1756890055, "Origin": "TENCENT_KMS", "Owner": "user", "ResourceId": "creatorUin/700001028674/07ad2031-69d3-11ef-9841-52540089bc41", "RotateDays": 365, "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", "LastRotateTime": 1725354040, "NextRotateTime": 1756890040, "Origin": "TENCENT_KMS", "Owner": "user", "ResourceId": "creatorUin/700001028674/fea98175-69d2-11ef-910d-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: 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. 错误码

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

错误码	描述
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameterValue.InvalidHsmClusterId	无效的 HSM 集群 ID。
UnauthorizedOperation	未授权操作。

获取主密钥列表详情

本页目录：