文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ User/ 获取当前用户的秘钥列表
更新时间：2025-07-15 GMT+08:00
查看PDF
分享

获取当前用户的秘钥列表

功能介绍

获取当前用户的秘钥列表

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v4/user/keys

表1 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释：

偏移量，从0开始。

取值范围：

0-2147483647

默认取值：

0

limit

否

Integer

参数解释：

返回数量。

取值范围：

1-100

默认取值：

20

query

否

String

参数解释：

key的标题名称。

取值范围：

字符串长度不少于1，不超过2000。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

必传。

取值范围：

字符串长度不少于1，不超过10万。

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

keys

Array of SSHKeyDto objects

参数解释：

密钥列表。

取值范围：

列表长度不少于0，不超过1000。

total

Integer

参数解释：

结果条数。

取值范围：

1-2147483647
表4 SSHKeyDto

参数

参数类型

描述

id

Integer

参数解释：

秘钥id。

取值范围：

1-2147483647

title

String

参数解释：

秘钥名称。

取值范围：

字符串长度不少于1，不超过1000。

key

String

参数解释：

公钥。

取值范围：

字符串长度不少于1，不超过1000。

created_at

String

参数解释：

创建时间。

取值范围：

字符串长度不少于1，不超过1000。

状态码：401

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

状态码：403

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

请求示例

GET https://{endpoint}/v4/user/keys

响应示例

状态码：200

获取当前用户的秘钥列表

{
  "keys" : [ {
    "id" : 2111842119,
    "title" : "lssh",
    "key" : "ssh-rsa AAAAB3...",
    "created_at" : "2022-12-14T11:22:57.000+08:00"
  } ]
}

状态码：401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "认证信息过期"
}

状态码：403

Bad Request

{
  "error_code" : "CH.004403",
  "error_msg" : "您没有操作权限，请升级权限后重试。"
}

状态码

状态码

描述

200

获取当前用户的秘钥列表

401

Unauthorized

403

Bad Request

错误码

请参见错误码。

父主题： User

相关文档