九游平台/ 代码托管 codearts repo/ api参考/ / / 获取ssh密钥列表
更新时间：2024-11-08 gmt 08:00

获取ssh密钥列表-九游平台

功能介绍

获取codearts repo的公钥列表。

调试

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

uri

get /v1/users/sshkey

请求参数

表1 请求header参数

参数

是否必选

参数类型

描述

x-auth-token

是

string

参数解释：

用户token。通过调用iam服务获取用户token接口获取（响应消息头中x-subject-token的值）。

约束限制：

必传。

取值范围：

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

默认取值：

不涉及。

响应参数

表2 响应body参数

参数

参数类型

描述

error

error object

参数解释：

接口调用时，响应错误。

取值范围：

无。

result

publickeylist object

参数解释：

返回获取的ssh密钥列表。

status

string

参数解释：

调用此接口的响应状态。

取值范围：

  • success，表示接口调用成功。
  • failed，表示接口调用失败。
表3 publickeylist

参数

参数类型

描述

sshkey

array of publickey objects

参数解释：

返回的ssh密钥列表。

total

integer

参数解释：

返回的ssh密钥总数。

取值范围：

0-2147483647
表4 error

参数

参数类型

描述

code

string

参数解释：

调用此接口失败时返回的错误码。

取值范围：

  • ch.10000，系统繁忙，请稍后再试。

message

string

参数解释：

调用此接口失败时返回的提示信息。

取值范围：

  • “系统繁忙，请稍后再试”。
表5 publickey

参数

参数类型

描述

id

string

参数解释：

密钥id。

取值范围：

只能由数字组成，且长度为[1-40]个字符。

key

string

参数解释：

密钥，由用户上传。

取值范围：

只能数字组成，且长度为[0-2048]个字符。

title

string

参数解释：

添加ssh密钥时输入的标题，由用户自定义输入。

取值范围：

长度为[0,255]个字符。

请求示例

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"
}

错误码

请参见错误码。

父主题：

相关文档

网站地图