手动运行流水线¶

POST /api/v8/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches

用户调用此接口，进行手动运行流水线操作。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口不允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`owner`	path	string	是	仓库所属空间地址（组织或个人的地址 path）
`repo`	path	string	是	仓库路径（path）
`workflow_id`	path	string	是	workflow 的 id，也可以传入带 `yml` 或 `yaml` 后缀的文件名（非全路径）
`access_token`	query	string	是	用户授权码

Request Body:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "ref": {
      "description": "分支名称或者 tag 名称",
      "type": "string"
    },
    "inputs": {
      "description": "自定义参数，key-value 形式",
      "type": "object"
    }
  },
  "required": ["ref", "inputs"]
}

响应参数¶

字段	类型	必返	可为空	说明
`workflow_id`	string	是	否	workflow 的 id
`workflow_run_id`	string	是	否	流水线运行 id

失败响应¶

以下为该接口可能返回的失败响应示例。

400 参数错误

{
  "error": "invalid_request",
  "message": "参数 ref 不能为空",
  "field": "ref"
}

401 未认证

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

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

HTTP 响应状态码¶

状态码	说明
`201`	已创建（Created）
`400`	参数错误（Bad Request）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）
`404`	未找到（Not Found）

请求示例¶

参数说明¶

<owner> 替换为仓库所属空间地址（组织或个人的地址 path）； <repo> 替换为仓库路径； <workflow_id> 替换为 workflow 的 id，或带 yml / yaml 后缀的文件名； <token> 替换为你的 AtomGit 用户访问令牌。

cURL¶

curl -X POST 'https://api.atomgit.com/api/v8/repos/<owner>/<repo>/actions/workflows/<workflow_id>/dispatches?access_token=<token>'   -H 'Content-Type: application/json'   -d '{"ref": "main", "inputs": {"name": "value"}}'

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch(
  "https://api.atomgit.com/api/v8/repos/<owner>/<repo>/actions/workflows/<workflow_id>/dispatches?access_token=<token>",
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "Accept": "application/json",
    },
    body: JSON.stringify({
      ref: "main",
      inputs: { name: "value" },
    }),
  },
);

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/workflows/<workflow_id>/dispatches",
    params={"access_token": "<token>"},
    headers={
        "Content-Type": "application/json",
        "Accept": "application/json",
    },
    json={"ref": "main", "inputs": {"name": "value"}},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 201

{
  "workflow_id": "123456",
  "workflow_run_id": "789012"
}

错误码¶

错误码	说明
`400`	参数错误或请求无法解析
`401`	未认证或凭证无效（缺少/无效的访问凭证）
`403`	禁止访问（无权限执行此操作）
`404`	请求路径不存在
`429`	请求过于频繁，触发限流
`500`	系统内部错误

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