获取仓库的远程镜像配置信息¶

GET /api/v5/repos/{owner}/{repo}/repo_remote_mirror

用户调用此接口，进行获取仓库的远程镜像配置信息操作。

访问令牌支持说明¶

AtomGit 用户访问令牌（AtomGit user access tokens）

是否允许匿名访问¶

此接口不允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`owner`	path	string	是	仓库所属空间地址(企业、组织或个人的地址path)
`repo`	path	string	是	仓库路径(path)
`access_token`	query	string	是	用户授权码

响应参数¶

字段	类型	必返	可为空	说明
`id`	integer	是	—	镜像配置ID
`project_id`	integer	是	—	项目ID
`update_status`	string	是	—	更新状态
`last_update_at`	string	是	—	最近更新时间
`url`	string	是	—	远程镜像URL
`last_successful_update_at`	string	是	—	最近成功更新时间
`number_of_failures`	integer	是	—	失败次数
`mirroring_enabled`	boolean	是	—	是否启用镜像
`is_private`	boolean	是	—	是否为私有镜像
`last_error`	string	是	—	最近一次错误信息
`force`	boolean	是	—	是否强制推送

失败响应¶

只有 200/成功响应是不够的：调用方需要知道失败长什么样才能写错误处理。

400 参数错误

{
  "error": "invalid_request",
  "message": "缺少必填参数 owner",
  "field": "owner"
}

401 未认证

{
  "error": "unauthorized",
  "message": "缺少或无效的访问令牌"
}

错误字段名以后端实际返回为准。

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`400`	参数错误（Bad request）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）
`404`	请求路径不存在（Not found）
`500`	系统内部错误（Internal server error）

请求示例¶

参数说明¶

<owner> 替换为仓库所属空间地址（企业、组织或个人的地址 path）；<repo> 替换为仓库路径（path）；<token> 替换为你的 AtomGit 用户访问令牌。本接口需要携带访问令牌，示例已在请求中附加 access_token 参数。

cURL¶

curl -X GET 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/repo_remote_mirror?access_token=<token>' -H 'Accept: application/json'

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch(
  "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/repo_remote_mirror?access_token=<token>",
  {
    headers: {
      "Accept": "application/json",
    },
  }
);

if (!response.ok) {
  throw new Error(`请求失败: ${response.status}`);
}

const data = await response.json();
console.log(data);

Python¶

import requests

resp = requests.get(
    "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/repo_remote_mirror",
    params={"access_token": "<token>"},
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

{
  "id": 10086,
  "project_id": 10086,
  "update_status": "success",
  "last_update_at": "2026-10-14 15:40:30",
  "url": "https://api.atomgit.com/upstream/project.git",
  "last_successful_update_at": "2026-10-14 15:40:30",
  "number_of_failures": 0,
  "mirroring_enabled": true,
  "is_private": false,
  "last_error": "",
  "force": false
}

错误码¶

错误码	说明
`401`	未认证或凭证无效（缺少/无效的访问凭证）
`400`	参数错误或请求无法解析
`404`	请求路径不存在
`405`	请求方法不支持
`429`	请求过于频繁，触发限流
`500`	系统内部错误

本页原文 Markdown：在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc