文档首页/ 数据加密服务 DEW/ API参考（阿布扎比区域）/ API说明/ 管理密钥/ 查询密钥列表
更新时间：2022-12-06 GMT+08:00
查看PDF
分享

查询密钥列表

功能介绍

查询用户所有密钥列表。

URI

  • URI格式

    POST /v1.0/{project_id}/kms/list-keys

  • 参数说明
    表1 参数说明

    参数

    是否必选

    参数类型

    描述

    project_id

    是

    String

    项目ID。

请求消息

表2 请求参数

参数

是否必选

参数类型

描述

limit

否

String

指定查询返回记录条数，如果指定查询记录条数小于存在的条数，响应参数“truncated”将返回“true”，表示存在分页。取值在密钥最大个数范围以内。例如：100

marker

否

String

分页查询起始位置标识。分页查询收到的响应参数“truncated”为“true”时，可以发送连续的请求获取更多的记录条数，“marker”设置为响应的next_marker的值。例如：10

enterprise_project_id

否

String

企业多项目ID。

  • 用户未开通企业多项目时，不需要输入该字段。
  • 用户开通企业多项目时，查询资源可以输入该字段。

    若用户不输入该字段，默认查询租户所有有权限的企业多项目下的资源。此时“enterprise_project_id”取值为“all”。

    若用户输入该字段，取值满足以下任一条件。

    • 取值为“all”
    • 取值为“0”
    • 满足正则匹配：“^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$”

key_state

否

String
密钥状态，满足正则匹配“^[1-5]{1}$”，枚举如下：
  • “1”表示待激活状态
  • “2”表示启用状态
  • “3”表示禁用状态
  • “4”表示计划删除状态
  • “5”表示等待导入状态

sequence

否

String

请求消息序列号，36字节序列号。

例如：919c82d4-8046-4722-9094-35c3c6524cff

响应消息

表3 响应参数

参数

是否必选

参数类型

描述

keys

是

Array of strings

key_id列表。

key_details

是

Array of objects

密钥详情列表，详情请参见表4。

next_marker

是

String

获取下一页所需要传递的“marker”值。当“truncated”为“false”时，“next_marker”为空。

total

是

Integer

密钥总条数。

truncated

是

String
是否还有下一页：
  • “true”表示还有数据。
  • “false”表示已经是最后一页。

示例

如下以查询返回记录条数为“2”，分页为“1”为例。

  • 请求样例 
    {
    "limit": "2",
    "marker": "1"
}
  • 响应样例 
    {
    "keys": [
        "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
        "2e258389-bb1e-4568-a1d5-e1f50adf70ea"
    ],
    "key_details": [
        {
        "key_id":"0d0466b0-e727-4d9c-b35d-f84bb474a37f",
        "domain_id":"00074811d5c27c4f8d48bb91e4a1dcfd",
        "key_alias":"caseuirpr",
        "realm":"aaaa",
        "key_description":"123",
        "creation_date":"1502799822000",
        "scheduled_deletion_date":"",
        "key_state":"2",
        "default_key_flag":"0",
        "key_type":"1",
        "expiration_time":"1501578672000",
        "origin":"kms"
},
        {
        "key_id":"2e258389-bb1e-4568-a1d5-e1f50adf70ea",
        "domain_id":"00074811d5c27c4f8d48bb91e4a1dcfd",
        "key_alias":"casehvniz",
        "realm":"aaaa",
        "key_description":"234",
        "creation_date":"1502799820000",             
        "scheduled_deletion_date":"",
        "key_state":"2",
        "default_key_flag":"0",
        "key_type":"1",
        "expiration_time":"1501578673000",
        "origin":"kms"
}
     ],
    "next_marker": "",
    "truncated": "false",
    "total":2
}

    或

    {
    "error": {
        "error_code": "KMS.XXXX",
        "error_msg": "XXX"
    }
}

状态码

表4描述的是API返回的正常状态码。
表4 状态码

状态码

编码

状态说明

200

OK

请求已成功。

异常状态码，请参见状态码。

父主题： 管理密钥