0

0

Jenkins Job如何通过API上传XML配置文件

煙雲

煙雲

发布时间:2026-01-25 10:04:02

|

240人浏览过

|

来源于php中文网

原创

Jenkins Job 配置更新必须使用 PUT 方法向 /job/{JOB_NAME}/config.xml 提交合法 XML,filename 必须为 config.xml,且需携带 Jenkins-Crumb 和 Basic Auth 认证;否则返回 400/403/404。

jenkins job如何通过api上传xml配置文件

POST 请求必须用 config.xml 作为文件名上传

Jenkins 的 Job 配置 API 不接受任意文件名,即使内容是合法 XML。如果你用 curl 或其他工具上传,Content-Disposition 中的 filename 字段**必须是 config.xml**,否则 Jenkins 会返回 400 Bad Request 或静默忽略配置更新。

  • 错误示例:filename="job-config.xml" → 失败
  • 正确写法:filename="config.xml"
  • 路径格式为:/job/{JOB_NAME}/config.xml(注意不是 /createItem
  • 需使用 PUT 方法,不是 POSTPOST 仅用于新建 job

需要先获取 CSRF token(Jenkins 2.176+ 默认启用)

未带有效 crumb 的请求会被拒绝,返回 403 No valid crumb was included in the request。不能跳过,也不能靠 Cookie 硬凑。

  • 先 GET /crumbIssuer/api/json 获取 crumbcrumbRequestField
  • crumb 值作为 header 加入后续 PUT 请求,字段名就是返回的 crumbRequestField(通常是 Jenkins-Crumb
  • 认证仍需 Basic Auth(-u user:api_token),token 推荐在用户设置页生成,不用密码

完整 curl 示例:上传前确保 XML 合法且无敏感信息硬编码

curl -X PUT \
  -H "Jenkins-Crumb: abc123..." \
  -u "alice:1a2b3c4d5e6f7g8h" \
  --data-binary @./my-job-config.xml \
  -H "Content-Type: application/xml" \
  "https://jenkins.example.com/job/my-pipeline/config.xml"

注意几点:

AdsGo AI
AdsGo AI

全自动 AI 广告专家,助您在数分钟内完成广告搭建、优化及扩量

下载
  • --data-binary 保证换行和空格不被破坏,@ 表示读取本地文件
  • XML 文件里不能含未转义的 &;建议用 Jenkins UI 导出一份原始 config.xml 当模板
  • 如果 job 不存在,该请求不会自动创建,会报 404 Not Found;需先用 /createItem 创建空 job,再上传配置

Python requests 调用容易漏掉的 headers 和编码细节

requests.put() 时,别直接传 data=open(...),否则可能因编码或缓冲导致 XML 解析失败。

  • 务必用 open(..., "rb") 二进制模式读取
  • 显式设置 headers={"Jenkins-Crumb": crumb},不要依赖 session 自动携带
  • auth=HTTPBasicAuth(user, token) 比拼接 user:pass 更安全
  • 检查响应状态码:200 表示成功;但 Jenkins 有时对非法 XML 也返回 200,只是实际没生效——建议上传后立即 GET /job/xxx/config.xml 对比校验
Jenkins 对 XML 结构校验较松,但字段缺失(比如 根节点不存在)会导致 job 无法保存或构建失败,上传前最好用一个测试 job 先验证。

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

774

2023.06.15

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

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

684

2023.07.20

python能做什么
python能做什么

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

767

2023.07.25

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

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

719

2023.07.31

python教程
python教程

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

1425

2023.08.03

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

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

570

2023.08.04

python eval
python eval

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

579

2023.08.04

scratch和python区别
scratch和python区别

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

751

2023.08.11

c++ 根号
c++ 根号

本专题整合了c++根号相关教程,阅读专题下面的文章了解更多详细内容。

41

2026.01.23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 19.3万人学习

Django 教程
Django 教程

共28课时 | 3.5万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号