获取项目保护 tag 详情¶

GET /api/v5/repos/{owner}/{repo}/protected_tags/{tag_name}

该接口用于获取指定仓库下某个保护 tag 的详情，返回该标签的名称、允许创建（推送）该标签的最低角色等级及对应的角色等级描述信息。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口不允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`owner`	path	string	是	仓库所属空间地址（组织或个人的地址 path）
`repo`	path	string	是	仓库路径（path）
`tag_name`	path	string	是	标签名称
`access_token`	query	string	是	用户授权码

响应参数¶

字段	类型	必返	可为空	说明
`name`	string	是	否	保护 tag 的标签名称
`create_access_level`	integer	是	是	允许创建（推送）该保护 tag 的最低角色等级；枚举：`0`（不允许任何人）、`30`（开发者、维护者、管理员）、`40`（维护者、管理员）
`create_access_level_desc`	string	是	是	`create_access_level` 对应的角色等级描述，如 `开发者、维护者、管理员`

失败响应¶

除成功响应外，本接口还可能返回以下失败响应（错误字段名以实际返回为准）：

401 未认证

{
  "error_code": 401,
  "error_code_name": "UNAUTHORIZED",
  "error_message": "Bad credentials",
  "trace_id": "string"
}

404 未找到 tag

{
  "error_code": 404,
  "error_code_name": "NOT_PATH",
  "error_message": "未找到 tag: tag_name",
  "trace_id": "string"
}

400 参数错误

{
  "error_code": 400,
  "error_code_name": "PARAMETER_ERROR",
  "error_message": "参数错误",
  "trace_id": "string"
}

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`400`	参数错误（Bad request）
`401`	需要认证（Requires authentication）
`404`	未找到（Not found）
`429`	请求过于频繁，触发限流（Too many requests）
`500`	系统内部错误（Internal server error）

请求示例¶

参数说明¶

<owner> 替换为仓库所属空间地址（组织或个人的地址 path）；
<repo> 替换为仓库路径（path）；
<tag_name> 替换为保护 tag 的标签名称；
<token> 替换为你的 AtomGit 用户访问令牌。

cURL¶

curl -X GET 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/protected_tags/<tag_name>?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>/protected_tags/<tag_name>?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>/protected_tags/<tag_name>",
    params={"access_token": "<token>"},
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

{
  "name": "tag_name",
  "create_access_level": 30,
  "create_access_level_desc": "开发者、维护者、管理员"
}

错误码¶

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

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