查询Fork仓同步状态¶

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

用户调用此接口，进行查询Fork仓同步状态操作。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口不允许匿名访问

请求参数¶

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

响应参数¶

字段	类型	必返	可为空	说明
`repo_sync_result`	boolean	是	否	Fork仓同步是否成功
`repo_sync_message`	string	是	否	Fork仓同步状态信息

失败响应¶

400 参数错误

{
  "error": "invalid_request",
  "message": "参数错误或请求无法解析",
  "field": "branch"
}

401 未认证

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

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`401`	需要认证（Requires authentication）

请求示例¶

参数说明¶

<owner> 替换为仓库所属空间地址（企业、组织或个人的地址 path）；<repo> 替换为仓库路径（path）；<token> 替换为你的 AtomGit 用户访问令牌；<branch> 替换为分支名称。

cURL¶

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

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const owner = "<owner>";
const repo = "<repo>";
const token = "<token>";
const branch = "<branch>";

const response = await fetch(
  `https://api.atomgit.com/api/v5/repos/${owner}/${repo}/sync_repo?access_token=${token}&branch=${branch}`,
  {
    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>/sync_repo",
    params={
        "access_token": "<token>",
        "branch": "<branch>",
    },
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

{
  "repo_sync_result": true,
  "repo_sync_message": "Fork仓库同步成功"
}

错误码¶

错误码	说明
`401`	未认证或凭证无效（缺少/无效的访问凭证）
`403`	禁止访问（Forbidden）
`404`	请求路径不存在
`429`	请求过于频繁，触发限流
`500`	系统内部错误

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