获取指定 Runner Group 的详细信息¶

GET /api/v8/orgs/{org}/actions/runner-groups/{runner_group_id}

用户调用此接口，进行获取指定 Runner Group 的详细信息操作。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口不允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`org`	path	string	是	组织path
`runner_group_id`	path	string	是	Runner Group ID
`access_token`	query	string	是	用户授权码

响应参数¶

字段	类型	必返	可为空	说明
`runner_group_id`	string	是	—	Runner Group ID
`runner_group_name`	string	是	—	Runner Group 名称
`share_all`	boolean	是	—	是否分享给全部仓库
`share_all_public_repos`	boolean	是	—	是否分享给全部公开仓库
`explicit_shared_repo_count`	integer	是	—	显式分享仓库数量
`created_at`	integer	是	—	创建时间
`updated_at`	integer	是	—	更新时间

失败响应¶

401 未认证

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

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

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）
`404`	资源不存在（Not found）

请求示例¶

参数说明¶

<org> 替换为组织路径（企业、组织或个人的地址 path）； <runner_group_id> 替换为 Runner Group 的 ID； <token> 替换为你的 AtomGit 用户访问令牌。

cURL¶

curl -X GET 'https://api.atomgit.com/api/v8/orgs/<org>/actions/runner-groups/<runner_group_id>?access_token=<token>' \
  -H 'Accept: application/json'

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch("https://api.atomgit.com/api/v8/orgs/<org>/actions/runner-groups/<runner_group_id>?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/v8/orgs/<org>/actions/runner-groups/<runner_group_id>",
    params={"access_token": "<token>"},
    headers={
        "Accept": "application/json",
    },
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

{
  "runner_group_id": "string",
  "runner_group_name": "string",
  "share_all": true,
  "share_all_public_repos": true,
  "explicit_shared_repo_count": 0,
  "created_at": 0,
  "updated_at": 0
}

错误码¶

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

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