重试失败任务¶

POST /api/v8/repos/{owner}/{repo}/actions/runs/{run_id}/retry

用户调用此接口,进行重试失败任务操作.

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口不允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`owner`	path	string	是	仓库所属空间地址(组织或个人的地址path)
`repo`	path	string	是	仓库路径(path)
`run_id`	path	string	是	流水线运行id
`access_token`	query	string	是	用户授权码

Request Body:

请求体为 application/json 格式，必填字段 job_run_ids 为待重试的任务 id 数组。

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "job_run_ids": {
      "description": "任务id数组",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": ["job_run_ids"]
}

响应参数¶

字段	类型	必返	可为空	说明
`success`	boolean	是	否	是否重试成功

失败响应¶

400 参数错误

{
  "error": "invalid_request",
  "message": "参数错误"
}

401 未认证

{
  "error": "unauthorized",
  "message": "缺少或无效的访问令牌"
}

错误字段名以后端实际返回为准。

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）

请求示例¶

参数说明¶

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

cURL¶

curl -X POST 'https://api.atomgit.com/api/v8/repos/<owner>/<repo>/actions/runs/<run_id>/retry?access_token=<token>' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{"job_run_ids": ["<job_run_id>"]}'

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch(
  "https://api.atomgit.com/api/v8/repos/<owner>/<repo>/actions/runs/<run_id>/retry?access_token=<token>",
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "Accept": "application/json",
    },
    body: JSON.stringify({ job_run_ids: ["<job_run_id>"] }),
  }
);

if (!response.ok) {
  throw new Error(`请求失败: ${response.status}`);
}

const data = await response.json();
console.log(data);

Python¶

import requests

resp = requests.post(
    "https://api.atomgit.com/api/v8/repos/<owner>/<repo>/actions/runs/<run_id>/retry",
    params={"access_token": "<token>"},
    headers={
        "Content-Type": "application/json",
        "Accept": "application/json",
    },
    json={"job_run_ids": ["<job_run_id>"]},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

{
  "success": true
}

错误码¶

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

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