九游平台/ 代码托管 codearts repo/ api参考/ / / 添加ssh密钥
更新时间：2025-01-20 gmt 08:00

添加ssh密钥-九游平台

功能介绍

在codearts repo中配置ssh密钥，实现本地计算机与您账号下的repo之间建立安全连接。

调试

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

uri

post /v1/users/sshkey

请求参数

表1 请求header参数

参数

是否必选

参数类型

描述

x-auth-token

是

string

参数解释：

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

约束限制：

必传。

取值范围：

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

默认取值：

不涉及。
表2 请求body参数

参数

是否必选

参数类型

描述

key

是

string

参数解释：

用户在本地生成的ssh密钥。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

title

是

string

参数解释：

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

取值范围：

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

响应参数

表3 响应body参数

参数

参数类型

描述

error

error object

参数解释：

接口调用时，响应错误。

取值范围：

无。

result

publickey object

参数解释：

接口调用的响应结果。

取值范围：

无。

status

string

参数解释：

调用此接口的响应状态。

取值范围：

  • success，表示接口调用成功。
  • failed，表示接口调用失败。
表4 error

参数

参数类型

描述

code

string

参数解释：

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

取值范围：

  • 40，表示密钥添加失败，您需要检查密钥是否有效。
  • ch.080002，表示密钥添加失败，该密钥已存在，您需要重新生成密钥。

message

string

参数解释：

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

取值范围：

  • “密钥添加失败，请检查密钥是否有效”。
  • “此密钥已存在，请重新生成密钥”。
表5 publickey

参数

参数类型

描述

id

string

参数解释：

密钥id。

取值范围：

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

key

string

参数解释：

密钥，由用户上传。

取值范围：

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

title

string

参数解释：

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

取值范围：

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

请求示例

post https://{endpoint}/v1/users/sshkey
{
  "title" : "repo@xxx.com",
  "key" : "ssh-rsa aaaab3nzac1yc2ea*********************************************************u7xcma6hu8nj1e0i46vobwyoonl3gh142bv repo@xxx.com"
}

响应示例

状态码： 200

ok

{
  "result" : {
    "id" : "1034531",
    "title" : "repo@xxx.com",
    "key" : "ssh-rsa aaaab3nzac1yc2ea*********************************************************u7xcma6hu8nj1e0i46vobwyoonl3gh142bv repo@xxx.com"
  },
  "status" : "success"
}

状态码

状态码

描述

200

ok

错误码

表6 错误码

状态码

错误码

错误信息

描述

处理措施

409

ch.080002

“此密钥已存在，请重新生成密钥”

表示codearts repo已配置该密钥，您需要在本地重新生成密钥。

在本地重新生成并在repo配置密钥。

200

ch.010202

“密钥添加失败，请检查密钥是否有效”

表示codearts repo无法添加该密钥，原因可能是您的密钥复制有误或者您输入的title有误。
  • 如果您的密钥没有复制完整，可重新在本地复制密钥。
  • 如果是title不符合规范，重新自定义输入title。

400

ch.080002

title不能为空

title必传

title必传。

400

ch.080002

key is empty

ssh key 必传

ssh key必传
父主题：

相关文档

网站地图