文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ Repository/ 将普通仓库与远程镜像关联
更新时间:2025-08-20 GMT+08:00
分享

将普通仓库与远程镜像关联

功能介绍

将普通仓库与远程镜像关联

调试

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

URI

POST /v4/repositories/{repository_id}/remote-mirror/associate

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

Integer

参数解释:

仓库的ID,通过查询用户所有仓库接口查询项目列表获取。

约束限制:

不涉及。

取值范围:

1-2147483647

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

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

默认取值:

不涉及。

响应参数

状态码:201

表3 响应Body参数

参数

参数类型

描述

id

Integer

参数解释:

仓库镜像配置ID。

repository_id

Integer

参数解释:

仓库ID。

update_status

String

参数解释:

同步状态。

last_update_at

String

参数解释:

最近修改时间。

url

String

参数解释:

镜像地址。

last_successful_update_at

String

参数解释:

最近同步成功时间。

number_of_failures

Integer

参数解释:

同步失败次数。

mirroring_enabled

Boolean

参数解释:

开启定时同步。

is_private

Boolean

参数解释:

私有镜像。

endpoint_uuid

String

参数解释:

拓展点uuid。

last_error

String

参数解释:

最近失败信息。

状态码:401

表4 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

状态码:403

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

状态码:404

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

请求示例

将普通仓库与远程镜像关联

POST /v4/repositories/123/remote-mirror/associate

{
  "url" : "https://example.com/0379d2da2bae4c38b3d2fbbdb6f2a3f2/test.git"
}

响应示例

状态码:201

镜像信息

{
  "id" : 12439,
  "repository_id" : 2112029391,
  "update_status" : "finished",
  "last_update_at" : "2025-04-24T20:04:44.000+08:00",
  "url" : "https://example.com/0379d2da2bae4c38b3d2fbbdb6f2a3f2/test.git",
  "last_successful_update_at" : "2025-04-24T20:04:44.000+08:00",
  "number_of_failures" : null,
  "mirroring_enabled" : false,
  "is_private" : false,
  "endpoint_uuid" : null,
  "last_error" : null
}

状态码:401

Unauthorized

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

状态码:403

Bad Request

{
  "error_code" : "CH.00401001",
  "error_msg" : "没有访问权限"
}

状态码:404

Not Found

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

状态码

状态码

描述

201

镜像信息

401

Unauthorized

403

Bad Request

404

Not Found

错误码

请参见错误码

相关文档