文档首页/ 代码托管 CodeArts Repo/ API参考（联盟区域）/ API/ SSHKey/ 获取ssh key列表
更新时间：2026-01-08 GMT+08:00
查看PDF
分享

获取ssh key列表

功能介绍

获取ssh key列表。

URI

GET /v1/users/sshkey

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

响应参数

状态码： 200

表2 响应Body参数

参数

参数类型

描述

error

Error object

响应错误

result

PublicKeyList object

响应结果

status

String

响应状态
表3 Error

参数

参数类型

描述

code

String

错误码

message

String

错误信息
表4 PublicKeyList

参数

参数类型

描述

sshkey

Array of PublicKey objects

密钥列表

total

Integer

密钥总数
表5 PublicKey

参数

参数类型

描述

id

String

密钥id

最小长度：1

最大长度：40

key

String

密钥

最小长度：0

最大长度：2048

title

String

密钥名称

请求示例

GET https://{endpoint}/v1/users/sshkey

响应示例

状态码： 200

OK

{
  "result" : {
    "total" : 2,
    "sshkey" : [ {
      "id" : "1015292",
      "title" : "reop1@test.com",
      "key" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQA*********************************************************Bqa/pE8buOrxri6AWqAky0bmtjSuVf reop1@test.com"
    }, {
      "id" : "1031709",
      "title" : "reop@test.com",
      "key" : "ssh-rsa AAAAB3NzaC1yc2EA*********************************************************U7xcma6HU8nj1E0i46VObWyOONl3gh142BV repo@test.com"
    } ]
  },
  "status" : "success"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： SSHKey