查询指定 Runner Group 下的所有 K8S Runner¶
GET /api/v8/orgs/{org}/actions/runner-groups/{runner_group_id}/runner-sets
查询指定 Runner Group 下的所有 K8S Runner。
访问令牌支持说明¶
- AtomGit 用户访问令牌(AtomGit user access tokens)
是否允许匿名访问¶
此接口不允许匿名访问
请求参数¶
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
org |
path | string | 是 | 组织path |
runner_group_id |
path | string | 是 | Runner Group ID |
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) |
401 |
需要认证(Requires authentication) |
403 |
禁止访问(Forbidden) |
请求示例¶
以下示例展示了如何调用本接口。
参数说明¶
<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>/runner-sets?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>/runner-sets?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>/runner-sets",
params={"access_token": "<token>"},
headers={
"Accept": "application/json",
},
timeout=10,
)
resp.raise_for_status()
print(resp.json())
响应示例¶
状态码: 200
{
"total_count": 0,
"runner_sets": [
{
"id": "string",
"runner_group_id": "string",
"name": "string",
"status": "string",
"required_labels": [
{
"label_name": "string",
"label_value": "string",
"label_color": "string"
}
],
"min_runner_size": 0,
"max_runner_size": 0,
"limit_cpu": 0,
"limit_memory": 0,
"image_name": "string",
"user_k8s_cluster_id": "string",
"user_k8s_cluster_name": "string",
"user_k8s_resource_type": "string",
"user_k8s_cluster_namespace": "string",
"user_k8s_url": "string",
"create_time": 0,
"update_time": 0,
"user_id": "string",
"user_name": "string",
"user_project_id": "string"
}
]
}
错误码¶
| 错误码 | 说明 |
|---|---|
401 |
未认证或凭证无效(缺少/无效的访问凭证) |
400 |
参数错误或请求无法解析 |
404 |
请求路径不存在 |
405 |
请求方法不支持 |
429 |
请求过于频繁,触发限流 |
500 |
系统内部错误 |
本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc