文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ Repository/ 批量检查仓库名
更新时间：2025-09-28 GMT+08:00
查看PDF
分享

批量检查仓库名

功能介绍

批量检查仓库名

调试

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

URI

POST /v4/repository-names/validations

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

必传。

取值范围：

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

默认取值：

不涉及。
表2 请求Body参数

参数

是否必选

参数类型

描述

name

否

String

参数解释：

仓库名。

约束限制：

  • 必填。

  • 大小写字母、数字、下划线开头，可包含大小写字母、数字、中划线、下划线、英文句点，但不能以.git、.atom或.结尾

  • 代码总路径长度（代码组名称和仓库名称总长度）不超过256字符

取值范围：

不涉及。

默认取值：

不涉及。

project_id

否

String

参数解释：

项目ID。

约束限制：

必填。

取值范围：

不涉及。

默认取值：

不涉及。

group_id

否

Integer

参数解释：

代码组ID，若需要检查的仓库名称在项目根目录下可不传此参数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

1-2147483647

取值范围：

1-2147483647

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

[数组元素]

Array of ValidateRepoNameResultDto objects

检查结果
表4 ValidateRepoNameResultDto

参数

参数类型

描述

name

String

参数解释：

仓库名。

约束限制：

  • 必填。

  • 大小写字母、数字、下划线开头，可包含大小写字母、数字、中划线、下划线、英文句点，但不能以.git、.atom或.结尾

  • 代码总路径长度（代码组名称和仓库名称总长度）不超过256字符

取值范围：

不涉及。

默认取值：

不涉及。

project_id

String

参数解释：

项目ID。

约束限制：

必填。

取值范围：

不涉及。

默认取值：

不涉及。

group_id

Integer

参数解释：

代码组ID，若需要检查的仓库名称在项目根目录下可不传此参数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

1-2147483647

取值范围：

1-2147483647

result

Boolean

参数解释：

是否校验通过

取值范围：

  • true，校验通过。

  • false，校验未通过。

约束限制：

不涉及。

error_message

String

参数解释：

异常信息

约束限制：

不涉及。

请求示例

批量检查仓库名

POST /api/v4/repository-names/validations

[ {
  "name" : "ff123",
  "group_id" : null,
  "project_id" : "7efec10fa1704f07aa118ea3d5a93413"
}, {
  "name" : "r1",
  "group_id" : null,
  "project_id" : "7efec10fa1704f07aa118ea3d5a93413"
}, {
  "name" : "fff",
  "group_id" : 2111926488,
  "project_id" : "7efec10fa1704f07aa118ea3d5a93413"
} ]

响应示例

状态码：200

批量检查结果

[ {
  "name" : "ff123",
  "project_id" : "7efec10fa1704f07aa118ea3d5a93413",
  "group_id" : null,
  "result" : true,
  "error_message" : null
}, {
  "name" : "r1",
  "project_id" : "7efec10fa1704f07aa118ea3d5a93413",
  "group_id" : null,
  "result" : false,
  "error_message" : "已存在同名仓库或代码组"
}, {
  "name" : "fff",
  "project_id" : "7efec10fa1704f07aa118ea3d5a93413",
  "group_id" : 2111926488,
  "result" : false,
  "error_message" : "已存在同名仓库或代码组"
} ]

状态码

状态码

描述

200

批量检查结果

错误码

请参见错误码。

父主题： Repository

相关文档