文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ ThirdParty/ 校验代码组部署秘钥在上层代码组或项目是否配置
更新时间：2025-07-24 GMT+08:00
查看PDF
分享

校验代码组部署秘钥在上层代码组或项目是否配置

功能介绍

校验代码组部署秘钥在上层代码组或项目是否配置

调试

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

URI

POST /v4/groups/{group_id}/deploy-keys/check-key

表1 路径参数

参数

是否必选

参数类型

描述

group_id

是

Integer

参数解释：

代码组id，代码组首页，Group ID后的数字Id

取值范围：

1-2147483647

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

必传。

取值范围：

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

默认取值：

不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

key

否

String

参数解释：

待检查密钥值。

取值范围：

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

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

exists

Boolean

参数解释：

部署秘钥在上层代码组或项目是否配置。

取值范围：

  • true，上层代码组或项目已配置该密钥。

  • false，上层代码组或项目未配置该密钥。

状态码：401

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

状态码：403

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

状态码：404

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

请求示例

POST https://{endpoint}/v4/groups/1/deploy-keys/check-key

{
  "key" : "ssh-rsa AAAAB3Nza*********************gdcdvS8= zhangsan@DESKTOP-12MP13A"
}

响应示例

状态码：200

OK

{
  "exists" : false
}

状态码：401

Unauthorized

{
  "error_code" : "CH.00000002",
  "error_msg" : "认证信息无法识别"
}

状态码：403

Bad Request

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

状态码：404

Not Found

{
  "error_code" : "CH.00402000",
  "error_msg" : "该仓库不存在,请检查后重试。"
}

状态码

状态码

描述

200

OK

401

Unauthorized

403

Bad Request

404

Not Found

错误码

请参见错误码。

父主题： ThirdParty

相关文档