用途:通过 Jenkins REST API 管理 Jenkins 作业、构建与流水线,适合在脚本或自动化流程中查询状态、触发构建并读取结果。
必要配置:需设置 JENKINS_URL(服务器地址,如 https://jenkins.example.com)、JENKINS_USER(用户名)和 JENKINS_TOKEN(API Token,在用户配置页的 API Token 处生成)。认证使用用户名与 Token,资料建议优先使用 API Token 而非密码。
主要能力:可列出作业及其颜色(状态)和 URL;获取指定作业信息与最近构建的结果、时间戳;触发普通构建或带参数构建(buildWithParameters,示例参数 BRANCH、ENV);查询构建状态(编号、结果、耗时、时间戳、是否进行中);获取控制台输出;查看构建队列;以及通过 Blue Ocean 接口获取流水线各阶段名称、结果和耗时。
使用方式:以 curl 携带 -u "$JENKINS_USER:$JENKINS_TOKEN" 请求对应 API 端点,JSON 结果可用 jq 过滤。普通作业用 build,参数化作业用 buildWithParameters 并通过 --data-urlencode 传参。
限制与注意:Jenkins 可能启用基于 crumb 的 CSRF 保护,若启用需先获取 crumb;资料强调触发构建前应始终确认。不同 Jenkins 版本的 API 与 Blue Ocean 可用性可能不同,资料未提供更多安装、平台或收费信息。