文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ SSH Key/ 获取SSH密钥列表
更新时间：2024-11-08 GMT+08:00
查看PDF
分享

获取SSH密钥列表

功能介绍

获取CodeArts Repo的公钥列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成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"
}

错误码

请参见错误码。

父主题： SSH Key

相关文档