跳转至

查询指定仓库下的所有主机 Runner

GET /api/v8/repos/{owner}/{repo}/actions/runners

查询指定仓库下的所有主机 Runner，返回 Runner 总数与 Runner 列表。

访问令牌支持说明

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

是否允许匿名访问

此接口不允许匿名访问

请求参数

参数名 位置 类型 必填 说明
owner path string 是 仓库所属空间地址（组织或个人的地址 path）
repo path string 是 仓库路径（path）
access_token query string 是 用户授权码
keyword query string 否 关键字过滤
page query integer 否 当前页码，默认 1
per_page query integer 否 每页的项目数，默认 10

响应参数

字段 类型 必返 可为空 说明
total_count integer 是 是 Runner 总数
runners object[] 是 是 Runner 列表

runners[] 对象

字段 类型 必返 可为空 说明
runners[].id string 是 是 Runner ID
runners[].runner_group_id string 是 是 Runner Group ID
runners[].runner_name string 是 是 Runner 名称
runners[].name string 是 是 名称
runners[].work_dir string 是 是 工作目录
runners[].labels object[] 是 是 标签列表
runners[].status string 是 是 状态，枚举：IDLE / BUSY / OFFLINE / DISABLE
runners[].create_time integer 是 是 创建时间
runners[].update_time integer 是 是 更新时间
runners[].memory number 是 是 内存使用率（%）
runners[].disk number 是 是 可用硬盘（GB）

runners[].labels[] 对象

字段 类型 必返 可为空 说明
runners[].labels[].label_name string 是 是 标签名称
runners[].labels[].label_value string 是 是 标签值
runners[].labels[].label_color string 是 是 标签颜色

请求示例

参数说明

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

cURL

curl -X GET 'https://api.atomgit.com/api/v8/repos/<owner>/<repo>/actions/runners?access_token=<token>&keyword=<keyword>&page=1&per_page=10' \
  -H 'Accept: application/json'

JavaScript

const response = await fetch(
  "https://api.atomgit.com/api/v8/repos/<owner>/<repo>/actions/runners?access_token=<token>&page=1&per_page=10",
  {
    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/repos/<owner>/<repo>/actions/runners",
    params={
        "access_token": "<token>",
        "page": 1,
        "per_page": 10,
    },
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例

状态码： 200

{
  "total_count": 2,
  "runners": [
    {
      "id": "12345",
      "runner_group_id": "67890",
      "runner_name": "runner-01",
      "name": "runner-01",
      "work_dir": "/home/runner/work",
      "labels": [
        {
          "label_name": "self-hosted",
          "label_value": "true",
          "label_color": "0e8a16"
        },
        {
          "label_name": "Linux",
          "label_value": "X64",
          "label_color": "0052cc"
        }
      ],
      "status": "IDLE",
      "create_time": 1720000000,
      "update_time": 1720001000,
      "memory": 35.5,
      "disk": 120.0
    },
    {
      "id": "12346",
      "runner_group_id": "67890",
      "runner_name": "runner-02",
      "name": "runner-02",
      "work_dir": "/home/runner/work",
      "labels": [
        {
          "label_name": "self-hosted",
          "label_value": "true",
          "label_color": "0e8a16"
        },
        {
          "label_name": "Windows",
          "label_value": "X64",
          "label_color": "bf3989"
        }
      ],
      "status": "BUSY",
      "create_time": 1720000000,
      "update_time": 1720002000,
      "memory": 62.0,
      "disk": 200.0
    }
  ]
}

错误码

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

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