- 創(chuàng)建一個有任務運行和查詢權限的用戶
- 較老版本的Jenkins操作關閉跨站腳本偽造請求保護,新版本的Jenkins無此選項了
-
官方文檔 HTTPS://WWW.JENKINS.IO/DOC/BOOK/USING/REMOTE-ACCESS-API/
curl -u USERNAME:PASSWORD "JENKINSURL:PORT/api/json?pretty=true"
# 可以加上&tree=jobs[name,url]進行顯示內容的展示
curl -u USERNAME:PASSWORD JENKINSURL:PORT/queue/api/json?pretty=true
![]()
![]()
![]()
![]()
# 獲取任務所有信息
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
# 獲取最后穩(wěn)定構建信息
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
- 操作Job需要驗證 crumb
- 獲取crumb使用
- 使用token發(fā)起接口
# 方式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的config
curl -u USERNAME:PASSWORD -O JENKINSURL:PORT/job/JOBNAME/config.xml
# 創(chuàng)建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}"
# 查看最新構建任務編號
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}"
from jenkinsapi import jenkins
my_jenkins = jenkins.Jenkins("JENKINSURL", "USERNAME", "PASSWORD", useCrumb=True)
# 需要注意,如果請求的url與Jenkins Location配置的Jenkins URL不一致時,獲取到的key會拼接上一截地址
print(my_jenkins.keys()) # 獲取所有的job名稱
for info in my_jenkins.get_jobs_info():
print(info) # 獲取job的url與名稱 比較卡
print(my_jenkins.get_queue().keys())
# 獲取job對象
my_job = my_jenkins.get_job("JOBSNAME")
# 獲取最后一次構建對象
print(my_job.get_last_build())
# 獲取最后一次完成的構建對象
print(my_job.get_last_completed_build())
# 獲取最后一次成功的構建對象
print(my_job.get_last_good_build())
# 獲取最后一次失敗的構建編號
print(my_job.get_last_failed_buildnumber())
# 獲取job的config
print(my_job.get_config())
# 創(chuàng)建job
# 先獲取到job的config
with open("config.xml", "w", encoding="utf-8") as f:
my = my_jenkins.get_job("JOBNAME").get_config()
f.write(my)
my_jenkins.create_job("NEWJOBNAME", open("./config.xml",encoding="utf-8").read())
# 復制job
my_jenkins.copy_job("JOBNAME", "NEWJOBNAME")
# 禁用job
my_job.disable()
# 啟用job
my_job.enable()
# 重命名job
my_jenkins.rename_job("JOBNAME", "NEWJOBNAME")
# 無參構建
my_jenkins.build_job("JOBNAME")
# 有參構建
my_jenkins.build_job("JOBNAME", params={"key": "value"})
# 刪除job
my_jenkins.delete_job("JOBNAME")
# 當前job對象是否在隊列/構建中
print(my_job.is_queued_or_running())
# 獲取指定構建ID的對象
build_object = my_job.get_build(BUILDID)
# 獲取構建對象的時間戳
print(build_object.get_timestamp())
# 獲取控制臺日志
print(build_object.get_console())
# 獲取構建參數(shù)
print(build_object.get_params())
# 獲取構建的狀態(tài)
print(build_object.get_status())
# 獲取構建的變更日志
print(build_object.get_changeset_items())
# 刪除指定構建
my_job.delete_build(BUILDID)