接口约束
4.1.8 密钥标签管理
4.1.8.1 查询密钥实例 功能介绍功能介绍
● 功能介绍：查询密钥实例。通过标签过滤，查询指定用户主密钥的详细信息。
调试
您可以在API Explorer中调试该接口。
URI
POST /v1.0/{project_id}/kms/{resource_instances}/action
表4-505 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID resource_insta
nces 是 String 资源实例，固定值为
resource_instances
请求参数
表4-506 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token。 通过调用IAM服务 获取用户Token接口获取（响应 消息头中X-Subject-Token的 值）。
表4-507 请求 Body 参数
参数 是否必选 参数类型 描述
limit 否 String 查询记录数（“action”为
“count”时，无需设置此参 数），如果“action”为
“filter”，默认为“10”。
limit的取值范围为
“1-1000”。
offset 否 String 索引位置。从offset指定的下一 条数据开始查询。查询第一页数 默认为“0”。 offset必须为数 字，不能为负数。
action 否 String 操作标识（可设置为“filter”
或者“count”）。
● filter：表示过滤。
● count：表示查询总条数。
tags 否 Array of Tag
objects 标签列表，key和value键值对的 集合。
matches 否 Array of
TagItem
sequence 否 String 请求消息序列号，36字节序列 号。 例如：
919c82d4-8046-4722-9094-35 c3c6524cff
表4-508 Tag
参数 是否必选 参数类型 描述
key 否 String 键。 最大长度36个unicode字
符。 key不能为空。不能包含非 打印字符“ASCII(0-31)”、
“*”、“<”、“>”、“\”、
“=”。
values 否 Array of
strings 标签值集合
表4-509 TagItem
参数 是否必选 参数类型 描述
key 否 String 键。 最大长度36个unicode字
符。 key不能为空。不能包含非
resources Array of
ActionResour ces objects
资源实例列表，详情请参见resource字段数据结 构说明。
total_count Integer 总记录数。
表4-511 ActionResources
参数 参数类型 描述 resource_deta
il
KeyDetails
object 密钥详情。
resource_nam
e String 资源名称，默认为空字符串。
tags Array of
TagItem
objects标签列表，没有标签，数组默认为空。
表4-512 KeyDetails
参数 参数类型 描述
key_id String 密钥ID。
domain_id String 用户域ID。
key_alias String 密钥别名。
realm String 密钥区域。
key_spec String 密钥生成算法。
● AES_256
● SM4
● RSA_2048
● RSA_3072
● RSA_4096
● EC_P256
● EC_P384
● SM2 key_usage String 密钥用途。
● ENCRYPT_DECRYPT
● SIGN_VERIFY key_descriptio
n String 密钥描述。
creation_date String 密钥创建时间，时间戳，即从1970年1月1日至该 时间的总秒数。
scheduled_del
etion_date String 密钥计划删除时间，时间戳，即从1970年1月1日 至该时间的总秒数。
参数 参数类型 描述
key_state String 密钥状态，满足正则匹配“^[1-5]{1}$”，枚举 如下：
ag String 默认主密钥标识，默认主密钥标识为1，非默认标 识为0。
key_type String 密钥类型。
expiration_tim
e String 密钥材料失效时间，时间戳，即从1970年1月1日 至该时间的总秒数。
origin String 密钥来源，默认为“kms”，枚举如下：
● kms表示密钥材料由kms生成kms表示密钥材 料由kms生成
● external表示密钥材料由外部导入 key_rotation_
enabled String 密钥轮换状态，默认为“false”，表示关闭密钥 轮换功能。
sys_enterprise
_project_id String 企业项目ID，默认为“0”。
● 对于开通企业项目的用户，表示资源处于默认 企业项目下。
● 对于未开通企业项目的用户，表示资源未处于 企业项目下。
表4-513 TagItem
参数 参数类型 描述
key String 键。 最大长度36个unicode字符。 key不能为 空。不能包含非打印字符“ASCII(0-31)”、
“*”、“<”、“>”、“\”、“=”。
value String 值。 每个值最大长度43个unicode字符，可以为 空字符串。 不能包含非打印字符
“ASCII(0-31)”、“*”、“<”、“>”、
“\”、“=”。
表4-514 响应 Body 参数
参数 参数类型 描述
error Object 错误信息返回体。
表4-515 ErrorDetail
参数 参数类型 描述
error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息
状态码： 401
表4-516 响应 Body 参数
参数 参数类型 描述
error Object 错误信息返回体。
表4-517 ErrorDetail
参数 参数类型 描述
error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息
状态码： 403
表4-518 响应 Body 参数
参数 参数类型 描述
error Object 错误信息返回体。
表4-519 ErrorDetail
参数 参数类型 描述
error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息
状态码： 404
表4-520 响应 Body 参数
参数 参数类型 描述
error Object 错误信息返回体。
表4-521 ErrorDetail
参数 参数类型 描述
error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息
状态码： 500
表4-522 响应 Body 参数
参数 参数类型 描述
error Object 错误信息返回体。
表4-523 ErrorDetail
参数 参数类型 描述
error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息
状态码： 502
表4-524 响应 Body 参数
参数 参数类型 描述
error Object 错误信息返回体。
表4-525 ErrorDetail
参数 参数类型 描述
error_msg String 错误请求返回的错误信息
状态码： 504
表4-526 响应 Body 参数
参数 参数类型 描述
error Object 错误信息返回体。
表4-527 ErrorDetail
参数 参数类型 描述
error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息
请求示例
{ "offset" : "100", "limit" : "100", "action" : "filter", "matches" : [ {
"key" : "resource_name", "value" : "resource1"
} ], "tags" : [ { "key" : "key1",
"values" : [ "value1", "value2" ] } ]
"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" : [ {
"total_count" : 1 }
您可以在API Explorer中调试该接口。