查询密钥信息
功能介绍
-
功能介绍：查询密钥详细信息。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v1.0/{project_id}/kms/describe-key
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
key_info |
KeyDetails object |
密钥详情。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
key_id |
String |
密钥ID。 |
|
domain_id |
String |
用户域ID。 |
|
key_alias |
String |
密钥别名。 |
|
realm |
String |
密钥区域。 |
|
key_spec |
String |
密钥生成算法。
|
|
key_usage |
String |
密钥用途。
|
|
key_description |
String |
密钥描述。 |
|
creation_date |
String |
密钥创建时间，时间戳，即从1970年1月1日至该时间的总秒数。 |
|
scheduled_deletion_date |
String |
密钥计划删除时间，时间戳，即从1970年1月1日至该时间的总秒数。 |
|
key_state |
String |
密钥状态，满足正则匹配“^[1-5]{1}$”，枚举如下：
|
|
default_key_flag |
String |
默认主密钥标识，默认主密钥标识为1，非默认标识为0。 |
|
key_type |
String |
密钥类型。 |
|
expiration_time |
String |
密钥材料失效时间，时间戳，即从1970年1月1日至该时间的总秒数。 |
|
origin |
String |
密钥来源，默认为“kms”，枚举如下：
|
|
key_rotation_enabled |
String |
密钥轮换状态，默认为“false”，表示关闭密钥轮换功能。 |
|
sys_enterprise_project_id |
String |
企业项目ID，默认为“0”。
|
|
keystore_id |
String |
密钥库ID |
|
key_label |
String |
密钥在加密机中的标签 |
|
partition_type |
String |
分区类型，枚举如下：
|
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
Object |
错误信息返回体。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码 |
|
error_msg |
String |
错误请求返回的错误信息 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
Object |
错误信息返回体。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码 |
|
error_msg |
String |
错误请求返回的错误信息 |
状态码： 403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
Object |
错误信息返回体。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码 |
|
error_msg |
String |
错误请求返回的错误信息 |
状态码： 404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
Object |
错误信息返回体。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码 |
|
error_msg |
String |
错误请求返回的错误信息 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
Object |
错误信息返回体。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码 |
|
error_msg |
String |
错误请求返回的错误信息 |
状态码： 502
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
Object |
错误信息返回体。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码 |
|
error_msg |
String |
错误请求返回的错误信息 |
状态码： 504
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
Object |
错误信息返回体。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码 |
|
error_msg |
String |
错误请求返回的错误信息 |
请求示例
查询ID为"0d0466b0-e727-4d9c-b35d-f84bb474a37f"密钥的详细信息。
{
"key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f"
}响应示例
状态码： 200
请求已成功
{
"key_info" : {
"key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
"domain_id" : "00074811d5c27c4f8d48bb91e4a1dcfd",
"key_alias" : "test",
"realm" : "test",
"key_description" : "key_description",
"creation_date" : "1502799822000",
"scheduled_deletion_date" : "",
"key_spec" : "AES_256",
"key_usage" : "ENCRYPT_DECRYPT",
"key_state" : "2",
"default_key_flag" : "0",
"key_type" : "1",
"expiration_time" : "1501578672000",
"origin" : "kms",
"key_rotation_enabled" : "false",
"sys_enterprise_project_id" : "0",
"partition_type" : "1"
}
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
|
400 |
请求参数有误 |
|
401 |
被请求的页面需要用户名和密码 |
|
403 |
认证失败 |
|
404 |
资源不存在，资源未找到 |
|
500 |
服务内部错误 |
|
502 |
请求未完成。服务器从上游服务器收到一个无效的响应 |
|
504 |
网关超时 |
错误码
请参见错误码。
