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

1. 接口描述

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

列出账号下面状态为Enabled， Disabled 和 PendingImport 的CMK KeyId 列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ListKeys。
Version	是	String	公共参数，本接口取值：2019-01-18。
Region	是	String	公共参数，详见产品支持的地域列表。
Offset	否	Integer	含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0 示例值：0
Limit	否	Integer	含义跟 SQL 查询的 Limit 一致，表示本次获最多获取 Limit 个元素。缺省值为10，最大值为200 示例值：2
Role	否	Integer	根据创建者角色筛选，默认 0 表示用户自己创建的cmk， 1 表示授权其它云产品自动创建的cmk 示例值：0
HsmClusterId	否	String	KMS 高级版对应的 HSM 集群 ID（仅对 KMS 独占版/托管版服务实例有效）。示例值：cls-hsm-3dflmo9g

3. 输出参数

参数名称	类型	描述
Keys	Array of Key	CMK列表数组示例值：[ { "KeyId": "515d337d-70b4-11ef-bc87-02ac442a5a1f" }, { "KeyId": "0ed49d3e-69d3-11ef-9841-52540089bc41" } ]
TotalCount	Integer	CMK的总数量示例值：100
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

获取主密钥列表

输入示例

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

{
    "Offset": 0,
    "Limit": 2,
    "Role": 0,
    "HsmClusterId": "cls-hsm-3dflmo9g"
}

输出示例

{
    "Response": {
        "Keys": [
            {
                "KeyId": "515d337d-70b4-11ef-bc87-02ac442a5a1f"
            },
            {
                "KeyId": "0ed49d3e-69d3-11ef-9841-52540089bc41"
            }
        ],
        "RequestId": "28c0e45c-c034-4d8b-b006-f018aa88597d",
        "TotalCount": 14
    }
}

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	未授权操作。