已关闭
feat(actions): 支持 查询指定仓库下的所有主机 Runner API #443
aflyingto创建于 7月9日关闭于 7月13日
aflyingto
7月13日 评论:
7月13日 评论:
验证记录
- 当前版本或分支: main
- 复现命令:
gc api --method GET "/api/v8/repos/aflyingto/pytorch_9466/actions/runners?per_page=10&page=1" - 实际结果:
{"total_count":0,"runners":[]}— API 端点可达,返回有效 JSON - API 规格:
GET /api/v8/repos/{owner}/{repo}/actions/runners,返回{total_count, runners: [{id, runner_group_id, runner_name, name, work_dir, labels}]} - 结论: 需求有效,API 可达,进入修复


背景
GitCode API 文档 2.0.0 已提供 Actions API。该 Issue 用于跟踪 gitcode-cli 对此接口的支持设计与实现。
API 摘要
GET/api/v8/repos/{owner}/{repo}/actions/runnersget_api_v8_repos_{owner}_{repo}_actions_runnerspipeline-v8falseRequest Parameters
ownerrepoaccess_tokenkeywordpageper_pageRequest Body
无。
Responses
200
application/jsonapplication/json schema
{ "type": "object", "properties": { "total_count": { "type": "integer", "description": "Runner 总数" }, "runners": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Runner ID" }, "runner_group_id": { "type": "string", "description": "Runner Group ID" }, "runner_name": { "type": "string", "description": "Runner 名称" }, "name": { "type": "string", "description": "名称" }, "work_dir": { "type": "string", "description": "工作目录" }, "labels": { "type": "array", "items": { "type": "object", "properties": { "label_name": { "type": "string", "description": "标签名称" }, "label_value": { "type": "string", "description": "标签值" }, "label_color": { "type": "string", "description": "标签颜色" } }, "description": "标签列表" }, "description": "标签列表" }, "status": { "type": "string", "description": "状态,\"IDLE\", \"BUSY\", \"OFFLINE\", \"DISABLE\"" }, "create_time": { "type": "integer", "description": "创建时间" }, "update_time": { "type": "integer", "description": "更新时间" }, "memory": { "type": "number", "description": "内存使用率(%)" }, "disk": { "type": "number", "description": "可用硬盘(GB)" } }, "description": "Runner 列表" }, "description": "Runner 列表" } }, "description": "com.gitcode.openapi.pojo.action.runner.BizActionRunnerListResp" }原始 OpenAPI Operation
{ "deprecated": false, "description": "", "operationId": "get_api_v8_repos_{owner}_{repo}_actions_runners", "tags": [ "pipeline-v8" ], "parameters": [ { "name": "owner", "in": "path", "description": "仓库所属空间地址(组织或个人的地址path)", "required": true, "schema": { "type": "string" } }, { "name": "repo", "in": "path", "description": "仓库路径(path)", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "关键字过滤", "example": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "当前页码", "example": 1, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "每页的项目数", "example": 10, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "total_count": { "type": "integer", "description": "Runner 总数" }, "runners": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Runner ID" }, "runner_group_id": { "type": "string", "description": "Runner Group ID" }, "runner_name": { "type": "string", "description": "Runner 名称" }, "name": { "type": "string", "description": "名称" }, "work_dir": { "type": "string", "description": "工作目录" }, "labels": { "type": "array", "items": { "type": "object", "properties": { "label_name": { "type": "string", "description": "标签名称" }, "label_value": { "type": "string", "description": "标签值" }, "label_color": { "type": "string", "description": "标签颜色" } }, "description": "标签列表" }, "description": "标签列表" }, "status": { "type": "string", "description": "状态,\"IDLE\", \"BUSY\", \"OFFLINE\", \"DISABLE\"" }, "create_time": { "type": "integer", "description": "创建时间" }, "update_time": { "type": "integer", "description": "更新时间" }, "memory": { "type": "number", "description": "内存使用率(%)" }, "disk": { "type": "number", "description": "可用硬盘(GB)" } }, "description": "Runner 列表" }, "description": "Runner 列表" } }, "description": "com.gitcode.openapi.pojo.action.runner.BizActionRunnerListResp" } } }, "headers": {} } }, "security": [], "method": "get", "path": "/api/v8/repos/{owner}/{repo}/actions/runners", "servers": [ { "url": "https://api.gitcode.com", "description": "正式环境" } ], "securitySchemes": {}, "info": { "title": "GicodeOpenAPI", "description": "", "version": "1.0.0" }, "postman": { "name": "查询指定仓库下的所有主机 Runner", "description": { "content": "", "type": "text/plain" }, "url": { "path": [ "api", "v8", "repos", ":owner", ":repo", "actions", "runners" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "access_token", "value": "" }, { "disabled": false, "description": { "content": "关键字过滤", "type": "text/plain" }, "key": "keyword", "value": "" }, { "disabled": false, "description": { "content": "当前页码", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "每页的项目数", "type": "text/plain" }, "key": "per_page", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) 仓库所属空间地址(组织或个人的地址path)", "type": "text/plain" }, "type": "any", "value": "", "key": "owner" }, { "disabled": false, "description": { "content": "(Required) 仓库路径(path)", "type": "text/plain" }, "type": "any", "value": "", "key": "repo" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" } }初步验收建议
infra-test/*仓库。access_token仅作为 API 参数记录,CLI 优先复用现有认证机制。