查询密钥信息
功能介绍
查询密钥详细信息。
URI
请求消息
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
| Content-Type | 是 | String | application/json |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| key_id | 是 | String | Key_id内容可使用密钥ID、别名(key_alias)或者URN。
|
| sequence | 否 | String | 请求消息序列号,36字节序列号。 例如:919c82d4-8046-4722-9094-35c3c6524cff |
响应消息
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| key_info | 是 | Array of objects | 密钥信息,详情请参见表5。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| key_id | 是 | String | 密钥ID。 |
| domain_id | 是 | String | 用户域ID。 |
| key_alias | 是 | String | 密钥别名。 |
| realm | 是 | String | 密钥区域。 |
| key_description | 是 | String | 密钥描述。 |
| key_spec | 是 | String | 密钥生成算法。
|
| key_usage | 是 | String | 密钥用途。
|
| creation_date | 是 | String | 密钥创建时间,时间戳,即从1970年1月1日至该时间的总秒数。 |
| scheduled_deletion_date | 是 | String | 密钥计划删除时间,时间戳,即从1970年1月1日至该时间的总秒数。 |
| key_state | 是 | String | 密钥状态:
|
| default_key_flag | 是 | String | 默认主密钥标识,默认主密钥标识为1,非默认标识为0。 |
| key_type | 是 | String | 密钥类型。 |
| expiration_time | 是 | String | 密钥材料失效时间,时间戳,即从1970年1月1日至该时间的总秒数。 |
| origin | 是 | String | 密钥来源,默认为“kms”,枚举如下:
|
| 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" } }