获取主密钥列表详情

最近更新时间:2019-04-25 17:15:53

1. 接口描述

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ListKeyDetail
Version String 公共参数,本接口取值:2019-01-18
Region String 公共参数,详见产品支持的地域列表
Offset Integer 含义跟 SQL 查询的 Offset 一致,表示本次获取从按一定顺序排列数组的第 Offset 个元素开始,缺省为0
Limit Integer 含义跟 SQL 查询的 Limit 一致,表示本次获最多获取 Limit 个元素。缺省值为10,最大值为200
Role Integer 根据创建者角色筛选,默认 0 表示用户自己创建的cmk, 1 表示授权其它云产品自动创建的cmk
OrderType Integer 根据CMK创建时间排序, 0 表示按照降序排序,1表示按照升序排序
KeyState Integer 根据CMK状态筛选, 0表示全部CMK, 1 表示仅查询Enabled CMK, 2 表示仅查询Disabled CMK
SearchKeyAlias String 根据KeyId或者Alias进行模糊匹配查询

3. 输出参数

参数名称 类型 描述
TotalCount Integer CMK的总数量
KeyMetadatas Array of KeyMetadata 返回的属性信息列表,此字段可能返回 null,表示取不到有效值。
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

输入示例

https://kms.tencentcloudapi.com/?Action=ListKeyDetail
&Offset=0
&Limit=2
&Role=0
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "1b580852-1e38-11e9-b129-5cb9019b4b00",
    "KeyMetadatas": [
      {
        "KeyId": "23e80852-1e38-11e9-b129-5cb9019b4b01",
        "Alias": "myalias",
        "CreateTime": 1548210729,
        "Description": "test cmk",
        "KeyState": "Enabled",
        "KeyUsage": "ENCRYPT_DECRYPT",
        "Type": 1,
        "CreatorUin": 1001,
        "KeyRotationEnabled": true,
        "Owner": "user",
        "NextRotateTime": 1553151489
      },
      {
        "KeyId": "23e80852-1e38-11e9-b129-5cb9019b4b02",
        "Alias": "testalias",
        "CreateTime": 1548210730,
        "Description": "test cmk",
        "KeyState": "Disabled",
        "KeyUsage": "ENCRYPT_DECRYPT",
        "Type": 1,
        "CreatorUin": 1001,
        "KeyRotationEnabled": true,
        "Owner": "user",
        "NextRotateTime": 1553151489
      }
    ],
    "TotalCount": 100
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
UnauthorizedOperation 未授权操作。