文档首页/ 密码安全中心 DEW/ API参考/ API/ 管理SSH密钥对/ 密钥对标签管理/ 查询密钥对实例 - ListResourceInstancesFilter
更新时间:2026-08-19 GMT+08:00
分享

查询密钥对实例 - ListResourceInstancesFilter

功能介绍

查询密钥对实例。通过标签过滤,筛选用户密钥对,返回密钥对列表

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

POST /v3/{project_id}/keypairs/resource-instances/filter

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID。可参考获取项目ID获取。

约束限制:

不涉及

取值范围:

以IAM服务接口返回值为准,字符长度32-32

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

参数解释:

查询记录数

约束限制:

  • limit必须为整数

取值范围:

1~1000

默认取值:

默认为“1000”

offset

Integer

参数解释:

索引位置。从offset指定的下一条数据开始查询。查询第一页数据时,将查询前一页数据时响应体中的值带入此参数

约束限制:

  • offset必须为整数

取值范围:

不涉及

默认取值:

offset默认为“0”

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)

约束限制:

不涉及

取值范围:

IAM服务查询用户Token接口为准

默认取值:

不涉及

表4 请求Body参数

参数

是否必选

参数类型

描述

tags

Array of Tag objects

参数解释:

标签列表,key和value键值对的集合。最多不超过10个

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

without_any_tag

Boolean

参数解释:

不包含任意一个标签,该字段为true时查询所有不带标签的资源,此时忽略 “tags”字段。该字段为false或者未提供该参数时,该条件不生效,即返回所有资源或按"tags","matches"等条件过滤。为空返回空值

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

matches

Array of TagMatches objects

参数解释:

搜索字段 - key为搜索的字段,目前仅支持搜索密钥对名称,值为“resource_name” - value为模糊匹配的值,最大长度为255个字符。为空返回空值

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

sys_tags

Array of Tag objects

参数解释:

标签列表,key和value键值对的集合。最多不超过10个

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表5 TagMatches

参数

是否必选

参数类型

描述

key

String

参数解释:

待匹配的字段

约束限制:

只能为密钥对资源名称

取值范围:

不涉及

默认取值:

不涉及

value

String

参数解释:

标签的值

约束限制:

不涉及

取值范围:

取值范围不超过255个字符,满足正则匹配"^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)$"

默认取值:

不涉及

表6 Tag

参数

是否必选

参数类型

描述

key

String

参数解释:

标签键

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

values

Array of strings

参数解释:

标签值集合

最多包含10个value。标签列表中的标签value值不允许重复。标签列表如果为空列表,表示匹配任意值。标签列表中多个value之间是“或”的关系,在key已经满足要求的前提下,满足请求中的某个value就会匹配出来

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表7 响应Body参数

参数

参数类型

描述

total_count

Integer

参数解释:

总记录数

取值范围:

不涉及

resources

Array of Resources objects

参数解释:

资源实例列表,详情请参见resource字段数据结构说明

取值范围:

不涉及

表8 Resources

参数

参数类型

描述

resource_id

String

参数解释:

凭据资源ID

取值范围:

不涉及

resource_name

String

参数解释:

资源名称,默认为空字符串

取值范围:

不涉及

tags

Array of TagItem objects

参数解释:

标签列表,没有标签,数组默认为空

参数解释:

不涉及

sys_tags

Array of TagItem objects

参数解释:

系统标签列表,没有标签,数组默认为空

取值范围:

不涉及

resource_detail

KeypairDetails object

参数解释:

资源信息

取值范围:

不涉及

total_count

Integer

参数解释:

标签数量

取值范围:

不涉及

表9 TagItem

参数

参数类型

描述

key

String

参数解释:

标签的名称

取值范围:

取值范围为1到128个字符,满足正则匹配"^((?!\s)(?!sys)[\p{L}\p{Z}\p{N}_.:=+\-@]*)(?<!\s)$"

value

String

参数解释:

标签的值

取值范围:

取值范围不超过255个字符,满足正则匹配"^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)$"

表10 KeypairDetails

参数

参数类型

描述

name

String

参数解释:

密钥对名称由英文字母、数字、下划线、中划线组成,长度不能超过255个字节

取值范围:

不涉及

uuid

String

参数解释:

密钥对UUID

取值范围:

不涉及

id

Long

参数解释:

密钥对ID

取值范围:

不涉及

type

String

参数解释:

密钥对类型

取值范围:

  • ssh

  • x509

scope

String

参数解释:

密钥对所属域,租户级或用户级

取值范围:

  • domain

  • user

public_key

String

参数解释:

SSH密钥对对应的公钥信息

取值范围:

不涉及

fingerprint

String

参数解释:

SSH密钥对应指纹信息

取值范围:

不涉及

project_id

String

参数解释:

项目ID。可通过IAM服务[查询指定IAM用户的项目列表]接口获取

取值范围:

以IAM服务接口返回值为准,字符长度32-32

domain_id

String

参数解释:

密钥对所属的租户的id

取值范围:

不涉及

description

String

参数解释:

SSH密钥对的描述信息

取值范围:

不涉及

user_id

String

参数解释:

SSH密钥对所属的用户ID

取值范围:

不涉及

created_at

Long

参数解释:

SSH密钥对创建的时间,时间戳,即从1970年1月1日至该时间的总秒数

取值范围:

不涉及

update_at

Long

参数解释:

SSH密钥对的更新时间,时间戳,即从1970年1月1日至该时间的总秒数

取值范围:

不涉及

freeze_flag

Integer

参数解释:

密钥冻结状态

取值范围:

  • 0:正常状态

  • 1:普通冻结

  • 2:公安冻结

  • 3:普通冻结及公安冻结

  • 4:违规冻结

  • 5:普通冻结及违规冻结

  • 6:公安冻结及违规冻结

  • 7:普通冻结、公安冻结及违规冻结

  • 8:未实名认证冻结

  • 9:普通冻结及未实名认证冻结

  • 10:公安冻结及未实名认证冻结

encrypt_id

String

参数解释:

生成算法

取值范围:

不涉及

key_id

String

参数解释:

密钥ID

取值范围:

不涉及

is_key_protection

Boolean

参数解释:

是否托管密钥

取值范围:

true或false

frozen_state

String

参数解释:

密钥冻结状态

取值范围:

0:正常状态

1:普通冻结

2:公安冻结

3:普通冻结及公安冻结

4:违规冻结

5:普通冻结及违规冻结

6:公安冻结及违规冻结

7:普通冻结、公安冻结及违规冻结

8:未实名认证冻结

9:普通冻结及未实名认证冻结

10:公安冻结及未实名认证冻结

请求示例

{
  "tags" : [ {
    "key" : "key1",
    "values" : [ "val1" ]
  } ]
}

响应示例

状态码:200

请求已成功

{
  "total_count" : 1,
  "resources" : [ {
    "resource_id" : "2d1152f2-290d-4756-a1d2-e12c14992416"
  } ]
}

状态码

状态码

描述

200

请求已成功

400

参数非法

401

鉴权失败

403

权限不足

404

资源未找到

500

系统异常

错误码

请参见错误码

相关文档