查询分享给仓库的所有 K8S Runner¶
GET /api/v8/repos/{owner}/{repo}/actions/shared-runner-sets
用户调用此接口,查询分享给仓库的所有 K8S 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 | 是 | 否 | RunnerSet 总数 |
runner_sets |
object[] | 是 | 是 | RunnerSet 列表 |
runner_sets 对象
| 字段 | 类型 | 必返 | 可为空 | 说明 |
|---|---|---|---|---|
runner_sets.id |
string | 是 | 否 | RunnerSet ID |
runner_sets.runner_group_id |
string | 是 | 是 | Runner Group ID |
runner_sets.name |
string | 是 | 是 | 名称 |
runner_sets.status |
string | 是 | 是 | 状态:using 使用中 / wait_release 释放中 |
runner_sets.required_labels |
object[] | 是 | 是 | 必需标签列表 |
runner_sets.min_runner_size |
integer | 是 | 是 | 最小 Runner 数量 |
runner_sets.max_runner_size |
integer | 是 | 是 | 最大 Runner 数量 |
runner_sets.limit_cpu |
integer | 是 | 是 | CPU 限制 |
runner_sets.limit_memory |
integer | 是 | 是 | 内存限制 |
runner_sets.image_name |
string | 是 | 是 | 镜像名称 |
runner_sets.user_k8s_cluster_id |
string | 是 | 是 | 用户 K8S 集群 ID |
runner_sets.user_k8s_cluster_name |
string | 是 | 是 | 用户 K8S 集群名称 |
runner_sets.user_k8s_resource_type |
string | 是 | 是 | 用户 K8S 资源类型 |
runner_sets.user_k8s_cluster_namespace |
string | 是 | 是 | 用户 K8S 命名空间 |
runner_sets.user_k8s_url |
string | 是 | 是 | 用户 K8S 地址 |
runner_sets.create_time |
integer | 是 | 是 | 创建时间 |
runner_sets.update_time |
integer | 是 | 是 | 更新时间 |
runner_sets.user_id |
string | 是 | 是 | 用户 ID |
runner_sets.user_name |
string | 是 | 是 | 用户名 |
runner_sets.user_project_id |
string | 是 | 是 | 用户项目 ID |
runner_sets.required_labels 对象¶
| 字段 | 类型 | 必返 | 可为空 | 说明 |
|---|---|---|---|---|
runner_sets.required_labels.label_name |
string | 是 | 是 | 标签名称 |
runner_sets.required_labels.label_value |
string | 是 | 是 | 标签值 |
runner_sets.required_labels.label_color |
string | 是 | 是 | 标签颜色 |
失败响应¶
该接口在参数错误或未认证时可能返回如下失败响应。错误字段名以后端实际返回为准。
400 参数错误
401 未认证
HTTP 响应状态码¶
| 状态码 | 说明 |
|---|---|
200 |
成功(OK) |
304 |
未修改(Not modified) |
400 |
参数错误(Bad request) |
401 |
需要认证(Requires authentication) |
403 |
禁止访问(Forbidden) |
404 |
资源不存在(Not found) |
请求示例¶
参数说明¶
<owner>替换为仓库所属空间地址 path(组织或个人的地址 path);<repo>替换为仓库路径(path);<token>替换为你的 AtomGit 用户访问令牌。
cURL¶
curl -X GET 'https://api.atomgit.com/api/v8/repos/<owner>/<repo>/actions/shared-runner-sets?access_token=<token>&page=1&per_page=10' \
-H 'Accept: application/json'
JavaScript¶
// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch(
"https://api.atomgit.com/api/v8/repos/<owner>/<repo>/actions/shared-runner-sets?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/shared-runner-sets",
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,
"runner_sets": [
{
"id": "rs_1001",
"runner_group_id": "rg_2001",
"name": "shared-k8s-runner-set",
"status": "using",
"required_labels": [
{
"label_name": "os",
"label_value": "linux",
"label_color": "blue"
}
],
"min_runner_size": 1,
"max_runner_size": 10,
"limit_cpu": 4,
"limit_memory": 8192,
"image_name": "ubuntu-22.04",
"user_k8s_cluster_id": "cluster_3001",
"user_k8s_cluster_name": "prod-cluster",
"user_k8s_resource_type": "deployment",
"user_k8s_cluster_namespace": "runner",
"user_k8s_url": "https://k8s.example.internal",
"create_time": 1728000000,
"update_time": 1728100000,
"user_id": "user_4001",
"user_name": "octocat",
"user_project_id": "proj_5001"
}
]
}
错误码¶
| 错误码 | 说明 |
|---|---|
400 |
参数错误或请求无法解析 |
401 |
未认证或凭证无效(缺少/无效的访问凭证) |
403 |
禁止访问(Forbidden) |
404 |
请求路径不存在 |
429 |
请求过于频繁,触发限流 |
500 |
系统内部错误 |
本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc