文档首页/ 数据加密服务 DEW/ API参考（吉隆坡区域）/ API说明/ 查询密钥信息
更新时间：2022-08-23 GMT+08:00
查看PDF
分享

查询密钥信息

功能介绍

查询密钥详细信息。

URI

  • URI格式

    POST /v1.0/{project_id}/kms/describe-key

  • 参数说明
    表1 参数说明

    参数

    是否必选

    参数类型

    描述

    project_id

    是

    String

    项目ID。

请求消息

表2 请求参数

参数

是否必选

参数类型

描述

key_id

是

String

密钥ID，36字节，满足正则匹配“^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$”。

例如：0d0466b0-e727-4d9c-b35d-f84bb474a37f

sequence

否

String

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

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

响应消息

表3 响应参数

参数

是否必选

参数类型

描述

key_info

是

Array of objects

密钥信息，详情请参见表4。
表4 key_info字段结构说明

参数

是否必选

参数类型

描述

key_id

是

String

密钥ID。

domain_id

是

String

用户域ID。

key_alias

是

String

密钥别名。

realm

是

String

密钥区域。

key_description

是

String

密钥描述。

creation_date

是

String

密钥创建时间，时间戳，即从1970年1月1日至该时间的总秒数。

scheduled_deletion_date

是

String

密钥计划删除时间，时间戳，即从1970年1月1日至该时间的总秒数。

key_state

是

String
密钥状态：
  • “1”表示待激活状态
  • “2”表示启用状态
  • “3”表示禁用状态
  • “4”表示计划删除状态
  • “5”表示等待导入状态

default_key_flag

是

String

默认主密钥标识，默认主密钥标识为1，非默认标识为0。

key_type

是

String

密钥类型。

expiration_time

是

String

密钥材料失效时间，时间戳，即从1970年1月1日至该时间的总秒数。

origin

是

String

密钥来源，默认为“kms”，枚举如下：

  • kms表示密钥材料由kms生成
  • external表示密钥材料由外部导入

示例

如下以查询密钥ID为“0d0466b0-e727-4d9c-b35d-f84bb474a37f”为例。

  • 请求样例 
    {
    "key_id": "0d0466b0-e727-4d9c-b35d-f84bb474a37f"
}
  • 响应样例 
    {
    "key_info": {
        "key_id": "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
        "domain_id": "b168fe00ff56492495a7d22974df2d0b",
        "key_alias": "kms_test",
        "realm": "aaa",
        "key_description": "",
        "creation_date": "1472442386000",
        "scheduled_deletion_date": "",
        "key_state": "2",
        "default_key_flag": "0",
        "key_type": "1",
        "expiration_time":"1501578672000",
        "origin":"kms"
        ,
    }
}

    或

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

状态码

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

状态码

编码

状态说明

200

OK

请求已成功。

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

父主题： API说明