更新时间:2026-03-19 GMT+08:00

查询密钥信息

功能介绍

查询密钥详细信息。

URI

  • URI格式

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

  • 参数说明
    表1 路径参数

    参数

    是否必选

    参数类型

    描述

    project_id

    String

    项目ID。

请求消息

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Content-Type

String

application/json

表3 请求参数

参数

是否必选

参数类型

描述

key_id

String

Key_id内容可使用密钥ID、别名(key_alias)或者URN。

  • 密钥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
  • 别名:别名是为用户为密钥设置的简称,是密钥的一种标识。以“alias/”开头。示例:alias/4555。
  • URN:每个别名都会自动匹配一个URN,具有唯一性。示例:kms:eu-de-ring0:3ba44455500dd43127:alias:4555。
    说明:

    “创建密钥别名”时,生成的alias_urn,即为URN。

sequence

String

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

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

响应消息

表4 响应参数

参数

是否必选

参数类型

描述

key_info

Array of objects

密钥信息,详情请参见表5

表5 key_info字段结构说明

参数

是否必选

参数类型

描述

key_id

String

密钥ID。

domain_id

String

用户域ID。

key_alias

String

密钥别名。

realm

String

密钥区域。

key_description

String

密钥描述。

key_spec

String

密钥生成算法。

  • AES_256
  • RSA_2048
  • RSA_3072
  • RSA_4096
  • EC_P256
  • EC_P384
  • SM2

key_usage

String

密钥用途。

  • ENCRYPT_DECRYPT
  • SIGN_VERIFY
  • GENERATE_VERIFY_MAC

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

sys_enterprise_project_id

String

企业项目ID,默认为“0”

对于开通企业项目的用户,表示资源处于默认企业项目下。

对于未开通企业项目的用户,表示资源未处于企业项目下。

示例

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

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

状态码

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

状态码

编码

状态说明

200

OK

请求已成功。

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