GitHub API工作流运行端点添加branch参数返回404问题求助

你遇到的问题是因为gh api的-f/-F参数是用于发送表单数据（对应POST/PUT等请求方法），而获取工作流运行记录的接口是GET请求，查询参数需要通过URL查询字符串或者--param参数传递，而非表单参数。

正确的命令写法 #

方法1：直接在URL后拼接查询参数 #

gh api repos/myorg/myrepo/actions/workflows/my-workflow.yaml/runs?branch=master

方法2：使用--param参数传递查询参数 #

gh api repos/myorg/myrepo/actions/workflows/my-workflow.yaml/runs --param branch=master

如果需要指定API版本头，写法如下：

gh api \
  -H "Accept: application/vnd.github+json" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  repos/myorg/myrepo/actions/workflows/my-workflow.yaml/runs --param branch=master

报错原因说明 #

-f参数会让gh api把参数以表单形式发送，而GET请求的表单参数会被解析成请求体而非URL查询参数，导致GitHub API无法识别这个请求，最终返回404。而--param参数是专门为GET请求的查询参数设计的，会自动将参数拼接到URL的查询字符串中，符合API的要求。

内容的提问来源于stack exchange，提问作者swagrov