一， Jenkins Api 简介
- Jenkins 对外暴露的动作交付入口
- 为外部程序提供入口，可以控制Jenkins
- 支持协议 - Http
- Api 接口支持用户名、密码认证
- Jenkins Api支持的典型功能：运行Job、查看任务状态、返回任务编号…等
二， Jenkins Api 环境准备
2.1 环境准备
- 创建一个有任务运行和查询权限的用户
- 较老版本的Jenkins操作关闭跨站脚本伪造请求保护，新版本的Jenkins无此选项了
- 官方文档 HTTPS://WWW.JENKINS.IO/DOC/BOOK/USING/REMOTE-ACCESS-API/
2.2 使用curl调用 获取所有Jobs接口
curl -u USERNAME:PASSWORD "JENKINSURL:PORT/api/json?pretty=true"
curl -u USERNAME:PASSWORD -g "JENKINSURL:PORT/api/json?pretty=true&tree=jobs[name,url]"
# 可以加上&tree=jobs[name,url]进行显示内容的展示
2.3 使用curl调用 获取所有构建队列
curl -u USERNAME:PASSWORD JENKINSURL:PORT/queue/api/json?pretty=true
2.4 使用curl调用 获取Job信息
# 获取任务所有信息
curl -u USERNAME:PASSWORD JENKINSURL:PORT/job/JOBNAME/api/json?pretty=true
# 获取最后一次构建信息
curl -u USERNAME:PASSWORD JENKINSURL:PORT/job/JOBNAME/lastBuild/api/json?pretty=true
# 获取最后稳定构建信息
curl -u USERNAME:PASSWORD JENKINSURL:PORT/job/JOBNAME/lastStableBuild/api/json?pretty=true
# 获取最后成功的构建
curl -u USERNAME:PASSWORD JENKINSURL:PORT/job/JOBNAME/lastSuccessfulBuild/api/json?pretty=true
# 获取最后完成的构建
curl -u USERNAME:PASSWORD JENKINSURL:PORT/job/JOBNAME/lastCompletedBuild/api/json?pretty=true
# 最近失败的构建
curl -u USERNAME:PASSWORD JENKINSURL:PORT/job/JOBNAME/lastFailedBuild/api/json?pretty=true
2.5 使用curl调用操作Job
获取crumb
- 操作Job需要验证 crumb
- 获取crumb使用
- 使用token发起接口
# 方式1：获取crumb
username_password="USERNAME:PASSWORD"
jenkins_url="JENKINSURL:PORT"
cookie_file="$(mktemp)"
jenkins_crumb=$(curl -s -f -u "${username_password}" --cookie-jar "${cookie_file}" -s "${jenkins_url}/crumbIssuer/api/xml?xpath=concat(//crumbRequestField,%22:%22,//crumb)")
# 方式2：使用token
操作job
# 获取job的config
curl -u USERNAME:PASSWORD -O JENKINSURL:PORT/job/JOBNAME/config.xml
# 创建job
curl -u USERNAME:PASSWORD "JENKINSURL:PORT/createItem?name=JOBNAME" --cookie "${cookie_file}" -X POST -H "${jenkins_crumb}" -H 'Content-Type:text/xml' --data-binary "@./config.xml"
# 复制job
curl -u USERNAME:PASSWORD "JENKINSURL:PORT/createItem?name=NEWJOBNAME&mode=copy&from=JOBNAME" --cookie "${cookie_file}" -X POST -H "${jenkins_crumb}"
# 修改job
curl -u USERNAME:PASSWORD "JENKINSURL:PORT/job/JOBNAME/config.xml" --cookie "${cookie_file}" -X POST -H "${jenkins_crumb}" -H 'Content-Type:text/xml' --data-binary "@./config.xml"
# 无参构建
curl -u USERNAME:PASSWORD "JENKINSURL:PORT/job/JOBNAME/build" --cookie "${cookie_file}" -X POST -H "${jenkins_crumb}"
# 有参构建
curl -u USERNAME:PASSWORD "JENKINSURL:PORT/job/JOBNAME/buildWithParameters" --cookie "${cookie_file}" -X POST -H "${jenkins_crumb}" --data-urlencode json='{"key1":"value1","key2":"value2"}'
# 删除job
curl -u USERNAME:PASSWORD "JENKINSURL:PORT/job/JOBNAME/doDelete" --cookie "${cookie_file}" -X POST -H "${jenkins_crumb}"
操作指定构建的Job
# 查看最新构建任务编号
curl -u USERNAME:PASSWORD "JENKINSURL:PORT/job/son_demo/lastBuild/buildNumber"
# 查看某次构建控制台日志
curl -u USERNAME:PASSWORD "JENKINSURL:PORT/job/JOBNAME/ID/logText/progressiveText"
# 删除某次构建
curl -u USERNAME:PASSWORD "JENKINSURL:PORT/job/JOBNAME/ID/doDelete" -X POST --cookie "${cookie_file}" -H "${jenkins_crumb}"
三， Java Jenkins Api 常用接口操作
参考文档：Java调用Jenkins API获取任务构建归档文件_使用java实现构建jenkins的job,并拿到构建结果-CSDN博客