查询密钥列表
功能介绍
功能介绍:查询用户所有密钥列表。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v1.0/{project_id}/kms/list-keys
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
String |
指定查询返回记录条数,如果指定查询记录条数小于存在的条数,响应参数“truncated”将返回“true”,表示存在分页。取值在密钥最大个数范围以内。例如:100 |
marker |
否 |
String |
分页查询起始位置标识。分页查询收到的响应参数“truncated”为“true”时,可以发送连续的请求获取更多的记录条数,“marker”设置为响应的next_marker的值。例如:10 |
key_state |
否 |
String |
密钥状态,满足正则匹配“^[1-5]{1}$”,枚举如下:
|
key_spec |
否 |
String |
密钥生成算法,默认为“AES_256”。查询所有(包含非对称)密钥需要指定参数“ALL”。
|
enterprise_project_id |
否 |
String |
企业多项目ID。用户未开通企业多项目时,不需要输入该字段。 用户开通企业多项目时,查询资源可以输入该字段。 若用户不输入该字段,默认查询租户所有有权限的企业多项目下的资源。 此时“enterprise_project_id”取值为“all”。 若用户输入该字段,取值满足以下任一条件.
|
sequence |
否 |
String |
请求消息序列号,36字节序列号。 例如:919c82d4-8046-4722-9094-35c3c6524cff |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
keys |
Array of strings |
key_id列表。 |
key_details |
Array of KeyDetails objects |
密钥详情列表。详情参见KeyDetails |
next_marker |
String |
获取下一页所需要传递的“marker”值。当“truncated”为“false”时,“next_marker”为空。 |
truncated |
String |
是否还有下一页:
|
total |
Integer |
密钥总条数。 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
密钥在加密机中的标签 |
状态码: 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 |
错误请求返回的错误信息 |
请求示例
{ "limit" : "2", "marker" : "1" }
响应示例
状态码: 200
请求已成功
{ "keys" : [ "0d0466b0-e727-4d9c-b35d-f84bb474a37f", "2e258389-bb1e-4568-a1d5-e1f50adf70ea" ], "key_details" : [ { "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f", "domain_id" : "00074811d5c27c4f8d48bb91e4a1dcfd", "key_alias" : "test", "realm" : "cn-north-7", "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" : "true", "sys_enterprise_project_id" : "0", "partition_type" : "1" }, { "key_id" : "2e258389-bb1e-4568-a1d5-e1f50adf70ea", "domain_id" : "00074811d5c27c4f8d48bb91e4a1dcfd", "key_alias" : "test", "realm" : "realm", "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" : "true", "sys_enterprise_project_id" : "0", "partition_type" : "1" } ], "next_marker" : "", "truncated" : "false", "total" : "2" }
状态码
状态码 |
描述 |
---|---|
200 |
请求已成功 |
400 |
请求参数有误 |
401 |
被请求的页面需要用户名和密码 |
403 |
认证失败 |
404 |
资源不存在,资源未找到 |
500 |
服务内部错误 |
502 |
请求未完成。服务器从上游服务器收到一个无效的响应 |
504 |
网关超时 |
错误码
请参见错误码。
