文档首页 > > API参考> API说明> 管理加密密钥> 查询密钥信息

查询密钥信息

分享
更新时间: 2019/08/16 10:32

功能介绍

查询密钥详细信息。

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_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表示密钥材料由外部导入

key_rotation_enabled

String

密钥轮换状态,默认为“false”,表示关闭密钥轮换功能。

示例

如下以查询密钥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",
            "key_rotation_enabled":"false"
        }
    }

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

状态码

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

状态码

编码

状态说明

200

OK

请求已成功。

异常状态码,请参见状态码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区