背景

GitCode API 文档 2.0.0 已提供 Actions API。该 Issue 用于跟踪 gitcode-cli 对此接口的支持设计与实现。

• API 文档: https://docs.gitcode.com/docs/apis/get-api-v-8-orgs-org-actions-runner-groups-runner-group-id-runners-sets
• 抓取日期: 2026-07-09
• 文档来源: GitCode OpenAPI 文档 Actions 分类

API 摘要

• 标题: 查询指定 Runner Group 下的所有 K8S Runner
• Method: GET
• Path: /api/v8/orgs/{org}/actions/runner-groups/{runner_group_id}/runner-sets
• Operation ID: get_api_v8_orgs_{org}_actions_runner_groups_{runner_group_id}_runners_sets
• Tags: pipeline-v8
• Deprecated: false
• Description: 无

Request Parameters

Request Body

无。

Responses

200

• Description: (empty)
• Headers: 无
• Content-Types: application/json

application/json schema

{
  "type": "object",
  "properties": {
    "total_count": {
      "type": "integer",
      "description": "RunnerSet 总数"
    },
    "runner_sets": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "RunnerSet ID"
          },
          "runner_group_id": {
            "type": "string",
            "description": "Runner Group ID"
          },
          "name": {
            "type": "string",
            "description": "名称"
          },
          "status": {
            "type": "string",
            "description": "状态，using 使用中  wait_release 释放中"
          },
          "required_labels": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "label_name": {
                  "type": "string",
                  "description": "标签名称"
                },
                "label_value": {
                  "type": "string",
                  "description": "标签值"
                },
                "label_color": {
                  "type": "string",
                  "description": "标签颜色"
                }
              },
              "description": "必需标签"
            },
            "description": "必需标签"
          },
          "min_runner_size": {
            "type": "integer",
            "description": "最小 Runner 数量"
          },
          "max_runner_size": {
            "type": "integer",
            "description": "最大 Runner 数量"
          },
          "limit_cpu": {
            "type": "integer",
            "description": "CPU 限制"
          },
          "limit_memory": {
            "type": "integer",
            "description": "内存限制"
          },
          "image_name": {
            "type": "string",
            "description": "镜像名称"
          },
          "user_k8s_cluster_id": {
            "type": "string",
            "description": "用户 K8S 集群 ID"
          },
          "user_k8s_cluster_name": {
            "type": "string",
            "description": "用户 K8S 集群名称"
          },
          "user_k8s_resource_type": {
            "type": "string",
            "description": "用户 K8S 资源类型"
          },
          "user_k8s_cluster_namespace": {
            "type": "string",
            "description": "用户 K8S 命名空间"
          },
          "user_k8s_url": {
            "type": "string",
            "description": "用户 K8S 地址"
          },
          "create_time": {
            "type": "integer",
            "description": "创建时间"
          },
          "update_time": {
            "type": "integer",
            "description": "更新时间"
          },
          "user_id": {
            "type": "string",
            "description": "用户 ID"
          },
          "user_name": {
            "type": "string",
            "description": "用户名"
          },
          "user_project_id": {
            "type": "string",
            "description": "用户项目 ID"
          }
        },
        "description": "RunnerSet 列表"
      },
      "description": "RunnerSet 列表"
    }
  },
  "description": "com.gitcode.openapi.pojo.action.runner.BizK8sRunnerSetListResp"
}

原始 OpenAPI Operation

{
  "deprecated": false,
  "description": "",
  "operationId": "get_api_v8_orgs_{org}_actions_runner_groups_{runner_group_id}_runners_sets",
  "tags": [
    "pipeline-v8"
  ],
  "parameters": [
    {
      "name": "org",
      "in": "path",
      "description": "组织path",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "runner_group_id",
      "in": "path",
      "description": "",
      "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": "RunnerSet 总数"
              },
              "runner_sets": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "RunnerSet ID"
                    },
                    "runner_group_id": {
                      "type": "string",
                      "description": "Runner Group ID"
                    },
                    "name": {
                      "type": "string",
                      "description": "名称"
                    },
                    "status": {
                      "type": "string",
                      "description": "状态，using 使用中  wait_release 释放中"
                    },
                    "required_labels": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "label_name": {
                            "type": "string",
                            "description": "标签名称"
                          },
                          "label_value": {
                            "type": "string",
                            "description": "标签值"
                          },
                          "label_color": {
                            "type": "string",
                            "description": "标签颜色"
                          }
                        },
                        "description": "必需标签"
                      },
                      "description": "必需标签"
                    },
                    "min_runner_size": {
                      "type": "integer",
                      "description": "最小 Runner 数量"
                    },
                    "max_runner_size": {
                      "type": "integer",
                      "description": "最大 Runner 数量"
                    },
                    "limit_cpu": {
                      "type": "integer",
                      "description": "CPU 限制"
                    },
                    "limit_memory": {
                      "type": "integer",
                      "description": "内存限制"
                    },
                    "image_name": {
                      "type": "string",
                      "description": "镜像名称"
                    },
                    "user_k8s_cluster_id": {
                      "type": "string",
                      "description": "用户 K8S 集群 ID"
                    },
                    "user_k8s_cluster_name": {
                      "type": "string",
                      "description": "用户 K8S 集群名称"
                    },
                    "user_k8s_resource_type": {
                      "type": "string",
                      "description": "用户 K8S 资源类型"
                    },
                    "user_k8s_cluster_namespace": {
                      "type": "string",
                      "description": "用户 K8S 命名空间"
                    },
                    "user_k8s_url": {
                      "type": "string",
                      "description": "用户 K8S 地址"
                    },
                    "create_time": {
                      "type": "integer",
                      "description": "创建时间"
                    },
                    "update_time": {
                      "type": "integer",
                      "description": "更新时间"
                    },
                    "user_id": {
                      "type": "string",
                      "description": "用户 ID"
                    },
                    "user_name": {
                      "type": "string",
                      "description": "用户名"
                    },
                    "user_project_id": {
                      "type": "string",
                      "description": "用户项目 ID"
                    }
                  },
                  "description": "RunnerSet 列表"
                },
                "description": "RunnerSet 列表"
              }
            },
            "description": "com.gitcode.openapi.pojo.action.runner.BizK8sRunnerSetListResp"
          }
        }
      },
      "headers": {}
    }
  },
  "security": [],
  "method": "get",
  "path": "/api/v8/orgs/{org}/actions/runner-groups/{runner_group_id}/runner-sets",
  "servers": [
    {
      "url": "https://api.gitcode.com",
      "description": "正式环境"
    }
  ],
  "securitySchemes": {},
  "info": {
    "title": "GicodeOpenAPI",
    "description": "",
    "version": "1.0.0"
  },
  "postman": {
    "name": "查询指定 Runner Group 下的所有 K8S Runner",
    "description": {
      "content": "",
      "type": "text/plain"
    },
    "url": {
      "path": [
        "api",
        "v8",
        "orgs",
        ":org",
        "actions",
        "runner-groups",
        ":runner_group_id",
        "runner-sets"
      ],
      "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": "org"
        },
        {
          "disabled": false,
          "description": {
            "content": "(Required) ",
            "type": "text/plain"
          },
          "type": "any",
          "value": "",
          "key": "runner_group_id"
        }
      ]
    },
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "method": "GET"
  }
}

初步验收建议

• 增加对应 API client/query 方法，保留 v8 路径。
• 设计 agent-friendly 的 CLI 命令、帮助文本、JSON 输出和错误处理。
• 单元测试覆盖参数映射、响应解析和错误路径。
• 如做真实命令验证，只能使用 infra-test/* 仓库。
• 不暴露或打印 token；文档中的 access_token 仅作为 API 参数记录，CLI 优先复用现有认证机制。