查询密钥实例
功能介绍
-
功能介绍：查询密钥实例。通过标签过滤，查询指定用户主密钥的详细信息。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v1.0/{project_id}/kms/{resource_instances}/action
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID |
|
resource_instances |
是 |
String |
资源实例，固定值为resource_instances |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
String |
查询记录数（“action”为“count”时，无需设置此参数），如果“action”为“filter”，默认为“10”。 limit的取值范围为“1-1000”。 |
|
offset |
否 |
String |
索引位置。从offset指定的下一条数据开始查询。查询第一页数据时，将查询前一页数据时响应体中的值带入此参数（“action”为“count”时，无需设置此参数）。如果“action”为“filter”，offset默认为“0”。 offset必须为数字，不能为负数。 |
|
action |
否 |
String |
操作标识（可设置为“filter”或者“count”）。
|
|
tags |
否 |
Array of Tag objects |
标签列表，key和value键值对的集合。
|
|
matches |
否 |
Array of TagItem objects |
搜索字段。
|
|
sequence |
否 |
String |
请求消息序列号，36字节序列号。 例如：919c82d4-8046-4722-9094-35c3c6524cff |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
resources |
Array of ActionResources objects |
资源实例列表，详情请参见resource字段数据结构说明。 |
|
total_count |
Integer |
总记录数。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
resource_id |
String |
资源ID。 |
|
resource_detail |
KeyDetails object |
密钥详情。 |
|
resource_name |
String |
资源名称，默认为空字符串。 |
|
tags |
Array of TagItem objects |
标签列表，没有标签，数组默认为空。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
分区类型，枚举如下：
|
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
key |
String |
键。 最大长度36个unicode字符。 key不能为空。不能包含非打印字符“ASCII(0-31)”、“*”、“<”、“>”、“\”、“=”。 |
|
value |
String |
值。 每个值最大长度43个unicode字符，可以为空字符串。 不能包含非打印字符“ASCII(0-31)”、“*”、“<”、“>”、“\”、“=”。 |
状态码： 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 |
错误请求返回的错误信息 |
请求示例
查询标签键为”key1“，标签值为”value1“或”value2“的密钥实例，起始位置为100，显示条数100。
{
"offset" : "100",
"limit" : "100",
"action" : "filter",
"tags" : [ {
"key" : "key1",
"values" : [ "value1", "value2" ]
} ]
}响应示例
状态码： 200
请求已成功
{
"resources" : [ {
"resource_id" : "90c03e67-5534-4ed0-acfa-89780e47a535",
"resource_detail" : [ {
"key_id" : "90c03e67-5534-4ed0-acfa-89780e47a535",
"domain_id" : "4B688Fb77412Aee5570E7ecdbeB5afdc",
"key_alias" : "tagTest_xmdmi",
"key_description" : "123",
"creation_date" : 1521449277000,
"scheduled_deletion_date" : "",
"key_state" : 2,
"default_key_flag" : 0,
"key_type" : 1,
"key_rotation_enabled" : false,
"expiration_time" : "",
"origin" : "kms",
"sys_enterprise_project_id" : "0",
"realm" : "test"
} ],
"resource_name" : "tagTest_xmdmi",
"tags" : [ {
"key" : "key",
"value" : "testValue!"
}, {
"key" : "haha",
"value" : "testValue"
} ]
} ],
"total_count" : 1
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
|
400 |
请求参数有误 |
|
401 |
被请求的页面需要用户名和密码 |
|
403 |
认证失败 |
|
404 |
资源不存在，资源未找到 |
|
500 |
服务内部错误 |
|
502 |
请求未完成。服务器从上游服务器收到一个无效的响应 |
|
504 |
网关超时 |
错误码
请参见错误码。
