怎么在Python中通过调用Jenkins API实现CI/CD流程的自动化触发与监控?

酷敏姑娘_5278

酷敏姑娘_5278

2026-09-24

315人浏览

原创

必须先获取crumb并携带jenkins-crumb请求头,再用api token认证post到/job/{jobname}/build;带参数则改用/buildwithparameters并url拼参。

怎么在python中通过调用jenkins api实现ci/cd流程的自动化触发与监控?

如何用 requests 调用 Jenkins REST API 触发构建

直接发 POST 请求到 /job/{job_name}/build 即可触发,但必须处理好认证和 CSRF 保护。Jenkins 默认开启 CRSF 防护,跳过它会返回 403 No valid crumb was included in the request。

实操建议:

  • 先用账户密码获取 crumb:requests.get("http://jenkins-url/crumbIssuer/api/json", auth=("user", "api_token")),响应里取 crumb 字段
  • 再用该 crumb + token 发构建请求:requests.post("http://jenkins-url/job/my-pipeline/build", headers={"Jenkins-Crumb": crumb}, auth=("user", "api_token"))
  • 若 job 含参数(如 BRANCH_NAME),改用 /buildWithParameters 并在 URL 中拼参:?BRANCH_NAME=main&TARGET_ENV=staging
  • 不要用 session.auth 长期复用,API Token 一旦泄露风险极高;建议从环境变量读取:os.getenv("JENKINS_TOKEN")

如何获取某次构建的实时状态与控制台日志

构建触发后返回的是 201 Created,但没给 build number——得靠 /job/{job_name}/lastBuild 或更稳妥的 /job/{job_name}/lastBuild/api/json 拉取最新构建元信息。

实操建议:

  • 轮询检查状态时,优先查 result 字段("SUCCESS"/"FAILURE"/"ABORTED"),而非只看 building 字段,因为构建可能瞬间结束
  • 拉控制台日志用 /job/{job_name}/{build_number}/consoleText,注意加 stream=True 避免一次性加载超大日志导致内存爆掉
  • 日志接口默认只返回前 50KB,如需完整日志,加参数 ?start=0 并分段请求(配合 nextStart 响应头)
  • 别用 time.sleep(1) 盲等,Jenkins 构建启动有延迟,首次查 lastBuild 可能还是上一次;建议先查 /job/{job_name}/api/json?tree=lastBuild[number] 拿到刚触发的编号

为什么用 Jenkins API 时经常遇到 401/403 却查不出原因

401 多半是凭据失效或未传认证头;403 则八成是 crumb 错误、URL 路径大小写不一致,或用户没被授予对应 job 的 Job/Build 权限。

Python Testing
Python Testing

Python 测试速查:运行 pytest、使用 mock/patch、参数化、fixtures、异步、覆盖率测试。

下载

实操建议:

  • 确认 Jenkins 用户已启用 API Token:进入用户配置页 → “API Token” → “Add new Token”,别用旧密码当 token
  • 检查 Jenkins URL 是否带路径前缀(如 http://jenkins.example.com/jenkins/),所有 API 路径必须严格匹配该上下文根
  • 测试 crumb 接口是否返回正常:curl -u user:token http://jenkins-url/crumbIssuer/api/json,如果也 403,说明用户权限不足或 Jenkins 安全配置禁用了 crumb 接口
  • 调试时打开响应头:resp.headers.get("X-Error") 或 resp.text,Jenkins 常在 body 里写明拒绝原因(比如 "No valid crumb..." 或 "user is missing Job/Build permission")

Python 脚本中如何安全管理 Jenkins 凭据与避免硬编码

把 token 写死在代码里等于公开暴露凭证;而用 input() 又无法用于定时任务或 CI 环境。

实操建议:

  • 生产脚本必须从环境变量读:os.environ["JENKINS_USER"] 和 os.environ["JENKINS_TOKEN"],CI 系统(如 GitHub Actions)可通过 secrets 注入
  • 本地开发可用 .env 文件,但务必加进 .gitignore,并用 python-dotenv 加载:load_dotenv()
  • 不要尝试用 Jenkins 的 credentials-binding 插件反向导出 token 给 Python 脚本——那是反模式;Python 进程应独立持有最小权限凭据
  • 对敏感操作(如删除 job、重放构建),在脚本里加确认提示:input("Confirm re-run build #123? (y/N): ") == "y",防止误操作扩散

真正麻烦的不是调通 API,而是 crumb 的生命周期管理、构建编号的竞态判断、以及日志流的断点续传——这些细节不处理好,自动化脚本会在高并发或长构建场景下静默失败。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1571

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

3744

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1589

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

21477

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2647

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2707

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1083

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

576

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2083

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程