ListKeyDetail
最近更新时间: 2025-10-20 17:05:53
1. 接口描述
接口请求域名： kms.api3.fincloud.tencent.cn。
根据指定Offset和Limit获取主密钥列表详情。
默认接口请求频率限制：100次/秒。
接口更新时间：2020-12-02 09:56:15。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：ListKeyDetail |
| Version | 是 | 否 | String | 公共参数，本接口取值：2019-01-18 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| Offset | 否 | 否 | Uint64 | 含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0 |
| Limit | 否 | 否 | Uint64 | 含义跟 SQL 查询的 Limit 一致，表示本次最多获取 Limit 个元素。缺省值为10，最大值为200 |
| Role | 否 | 否 | Uint64 | 根据创建者角色筛选，默认 0 表示用户自己创建的cmk， 1 表示授权其它云产品自动创建的cmk |
| OrderType | 否 | 否 | Uint64 | 根据CMK创建时间排序， 0 表示按照降序排序，1表示按照升序排序 |
| KeyState | 否 | 否 | Uint64 | 根据CMK状态筛选， 0表示全部CMK， 1 表示仅查询Enabled CMK， 2 表示仅查询Disabled CMK，3 表示查询PendingDelete 状态的CMK(处于计划删除状态的Key)，4 表示查询 PendingImport 状态的CMK |
| SearchKeyAlias | 否 | 否 | String | 根据KeyId或者Alias进行模糊匹配查询 |
| Origin | 否 | 否 | String | 根据CMK类型筛选， "TENCENT_KMS" 表示筛选密钥材料由KMS创建的CMK， "EXTERNAL" 表示筛选密钥材料需要用户导入的 EXTERNAL类型CMK，"ALL" 或者不设置表示两种类型都查询，大小写敏感。 |
| KeyUsage | 否 | 否 | String | 根据CMK的KeyUsage筛选，ALL表示筛选全部，可使用的参数为：ALL 或 ENCRYPT_DECRYPT 或 ASYMMETRIC_DECRYPT_RSA_2048 或 ASYMMETRIC_DECRYPT_SM2，为空则默认筛选ENCRYPT_DECRYPT类型 |
| TagFilters | 否 | 否 | Array of TagFilter | 标签过滤条件 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Uint64 | CMK的总数量 |
| KeyMetadatas | KeyMetadata | 返回的属性信息列表。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| InternalError | 内部错误。 |
| UnauthorizedOperation | 未授权操作。 |