如何使用curl更新Jenkins Job的config.xml及编辑作业参数

嘿，这两个关于用curl操作Jenkins Job配置的问题我刚好熟，给你一步步讲清楚～

要直接用curl替换Jenkins Job的config.xml，你需要先搞定认证，再执行PUT请求，具体步骤如下：

• 第一步：准备认证信息
  你需要Jenkins的用户名和API令牌（在Jenkins个人主页→设置→API令牌里生成，记得保存好，生成后就看不到了）。如果你的Jenkins开启了CSRF保护，还要先获取crumb值，执行这个命令：

  curl -u 你的用户名:你的API令牌 "http://你的Jenkins地址/crumbIssuer/api/xml?xpath=concat(//crumbRequestField,\":\",//crumb)"
  

  会返回类似Jenkins-Crumb:abc123def456的结果，后面要用到。

• 第二步：准备好要上传的config.xml文件
  把你编辑好的config.xml存在本地，比如命名为new_config.xml，确保XML结构是Jenkins能识别的（最好先从现有Job导出一份来修改，避免格式错误）。

• 第三步：执行更新命令
  如果没有CSRF保护，直接用这个命令：

  curl -X PUT -u 你的用户名:你的API令牌 "http://你的Jenkins地址/job/你的Job名称/config.xml" --data-binary "@new_config.xml" -H "Content-Type: text/xml"
  

  如果有CSRF保护，就把之前获取的crumb加到Header里：

  curl -X PUT -u 你的用户名:你的API令牌 "http://你的Jenkins地址/job/你的Job名称/config.xml" --data-binary "@new_config.xml" -H "Content-Type: text/xml" -H "Jenkins-Crumb:abc123def456"
  

  命令里的--data-binary是关键，它会完整保留XML里的换行和格式，避免解析出错。

其实核心还是更新config.xml，但重点是找到并修改参数对应的XML节点，步骤更细化：

• 第一步：先导出当前Job的config.xml
  先把现有配置拉到本地，这样可以在原有基础上修改，不用从头写：

  curl -u 你的用户名:你的API令牌 "http://你的Jenkins地址/job/你的Job名称/config.xml" > current_config.xml
  

• 第二步：编辑参数部分
  打开current_config.xml，找到参数定义的节点：

  • 普通自由风格Job的参数一般在<properties>→<hudson.model.ParametersDefinitionProperty>→<parameterDefinitions>下面
  • 流水线Job的参数可能在<definition>→<parameters>下面

  举个例子，如果要修改一个字符串参数的默认值，找到对应的节点：

  <hudson.model.StringParameterDefinition>
    <name>DEPLOY_ENV</name>
    <description>目标部署环境</description>
    <defaultValue>test</defaultValue>
  </hudson.model.StringParameterDefinition>
  

  把<defaultValue>改成你想要的值，比如prod；如果要加新参数，直接在<parameterDefinitions>里加一个新的参数节点就行，比如加一个布尔参数：

  <hudson.model.BooleanParameterDefinition>
    <name>SKIP_TESTS</name>
    <description>是否跳过测试环节</description>
    <defaultValue>false</defaultValue>
  </hudson.model.BooleanParameterDefinition>
  

• 第三步：上传修改后的config.xml
  用和第一个问题一样的PUT命令，把修改后的文件传回去就行：

  curl -X PUT -u 你的用户名:你的API令牌 "http://你的Jenkins地址/job/你的Job名称/config.xml" --data-binary "@current_config.xml" -H "Content-Type: text/xml"
  

  有CSRF保护的话记得加crumb Header。

一些注意事项 #

• 操作前一定要备份原config.xml，万一改错了能快速恢复
• 确保你的Jenkins用户有该Job的「Configure」权限，不然会返回403错误
• 如果你的Jenkins是HTTPS的，记得把命令里的http改成https，如果有自签证书，可能需要加-k参数忽略证书验证（生产环境不建议这么做）

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