一、Jenkins Api簡介
Jenkins 對外暴露的動作交付入口
為外部程序提供入口,可以控制Jenkins
支持協(xié)議 - Http
Api 接口支持用戶名、密碼認(rèn)證
Jenkins Api支持的典型功能:運(yùn)行Job、查看任務(wù)狀態(tài)、返回任務(wù)編號…等
二、Jenkins Api 環(huán)境準(zhǔn)備
創(chuàng)建一個有任務(wù)運(yùn)行和查詢權(quán)限的用戶
較老版本的Jenkins操作關(guān)閉跨站腳本偽造請求保護(hù),新版本的Jenkins無此選項(xiàng)了
1、獲取所有job接口
curl -u USERNAME:PASSWORD “JENKINSURL:PORT/api/json?pretty=true”
[root@mylinux1 ~]# curl -u admin:admin "http://192.168.22.3:8080/api/json?pretty=true"
2、獲取所有job名字接口
[root@mylinux1 ~]# curl -u admin:admin -g "http://192.168.22.3:8080/api/json?pretty=true&tree=jobs[name]"
{
"_class" : "hudson.model.Hudson",
"jobs" : [
{
"_class" : "hudson.model.FreeStyleProject",
"name" : "build_no_params"
},
{
"_class" : "hudson.model.FreeStyleProject",
"name" : "build_with_params"
},
{
"_class" : "hudson.model.FreeStyleProject",
"name" : "father_job"
},
{
"_class" : "hudson.model.FreeStyleProject",
"name" : "first_job"
},
{
"_class" : "hudson.model.FreeStyleProject",
"name" : "git_demo"
3、獲取所有job名字和url接口
[root@mylinux1 ~]# curl -u admin:admin -g "http://192.168.22.3:8080/api/json?pretty=true&tree=jobs[name,url]"
{
"_class" : "hudson.model.Hudson",
"jobs" : [
{
"_class" : "hudson.model.FreeStyleProject",
"name" : "build_no_params",
"url" : "http://192.168.22.3:8080/job/build_no_params/"
},
{
"_class" : "hudson.model.FreeStyleProject",
"name" : "build_with_params",
"url" : "http://192.168.22.3:8080/job/build_with_params/"
},
{
"_class" : "hudson.model.FreeStyleProject",
"name" : "father_job",
"url" : "http://192.168.22.3:8080/job/father_job/"
},
三、使用curl調(diào)用 獲取所有構(gòu)建隊(duì)列
curl -u USERNAME:PASSWORD JENKINSURL:PORT/queue/api/json?pretty=true
[root@mylinux1 ~]# curl -u admin:admin "http://192.168.22.3:8080/queue/api/json?pretty=true"
{
"_class" : "hudson.model.Queue",
"discoverableItems" : [
],
"items" : [
]
四、使用curl調(diào)用 獲取Job信息
獲取任務(wù)所有信息
curl -u USERNAME:PASSWORD JENKINSURL:PORT/job/JOBNAME/api/json?pretty=true
[root@mylinux1 ~]# curl -u admin:admin "http://192.168.22.3:8080/job/build_with_params/api/json?pretty=true"
獲取最后一次構(gòu)建信息
curl -u USERNAME:PASSWORD JENKINSURL:PORT/job/JOBNAME/lastBuild/api/json?pretty=true
[root@mylinux1 ~]# curl -u admin:admin "http://192.168.22.3:8080/job/build_with_params/lastBuild/api/json?pretty=true"
獲取最后穩(wěn)定構(gòu)建信息
curl -u USERNAME:PASSWORD JENKINSURL:PORT/job/JOBNAME/lastStableBuild/api/json?pretty=true
[root@mylinux1 ~]# curl -u admin:admin "http://192.168.22.3:8080/job/build_with_params/lastStableBuild/api/json?pretty=true"
獲取最后成功的構(gòu)建
curl -u USERNAME:PASSWORD JENKINSURL:PORT/job/JOBNAME/lastSuccessfulBuild/api/json?pretty=true
[root@mylinux1 ~]# curl -u admin:admin "http://192.168.22.3:8080/job/build_with_params/lastSuccessfulBuild/api/json?pretty=true"
獲取最后完成的構(gòu)建
curl -u USERNAME:PASSWORD JENKINSURL:PORT/job/JOBNAME/lastCompletedBuild/api/json?pretty=true
[root@mylinux1 ~]# curl -u admin:admin "http://192.168.22.3:8080/job/build_with_params/lastCompletedBuild/api/json?pretty=true"
最近失敗的構(gòu)建
curl -u USERNAME:PASSWORD JENKINSURL:PORT/job/JOBNAME/lastFailedBuild/api/json?pretty=true
[root@mylinux1 ~]# curl -u admin:admin "http://192.168.22.3:8080/job/maven_demo/lastFailedBuild/api/json?pretty=true"
五、使用curl調(diào)用操作Job
1、操作Job需要驗(yàn)證crumb
a、使用token發(fā)起接口(不推薦)
b、獲取crumb使用
[root@mylinux1 ~]# username_password="admin:admin"
[root@mylinux1 ~]# jenkins_url="http://192.168.22.3:8080"
[root@mylinux1 ~]# cookie_file="$(mktemp)"
[root@mylinux1 ~]# jenkins_crumb=$(curl -s -f -u "${username_password}" --cookie-jar "${cookie_file}" -s "${jenkins_url}/crumbIssuer/api/xml?xpath=concat(//crumbRequestField,%22:%22,//crumb)")
[root@mylinux1 ~]# echo $jenkins_crumb
Jenkins-Crumb:bcc9f0c335fbcffe6e12f5aa4398ec2bdc74749b72b3389003bdc3f321d9b164
c、上面命令操作完成后會生成config.xml文件
[root@mylinux1 ~]# ls config.xml
config.xml
vim config.xml
<?xml version='1.1' encoding='UTF-8'?>
<project>
<description></description>
<keepDependencies>false</keepDependencies>
<properties/>
<scm class="hudson.scm.NullSCM"/>
<canRoam>true</canRoam>
<disabled>false</disabled>
<blockBuildWhenDownstreamBuilding>false</blockBuildWhenDownstreamBuilding>
<blockBuildWhenUpstreamBuilding>false</blockBuildWhenUpstreamBuilding>
<triggers/>
<concurrentBuild>false</concurrentBuild>
<builders>
<hudson.tasks.Shell>
<command>echo "good"</command>
<configuredLocalRules/>
</hudson.tasks.Shell>
</builders>
<publishers/>
<buildWrappers/>
</project>
2、創(chuàng)建job
[root@mylinux1 ~]# curl -u "${username_password}" "${jenkins_url}/createItem?name=create_job2" --cookie "${cookie_file}" -X POST -H "${jenkins_crumb}" -H 'Content-Type:text/xml' --data-binary "@./config.xml"
[root@mylinux1 ~]#
3、復(fù)制job
[root@mylinux1 ~]# curl -u "${username_password}" "${jenkins_url}/createItem?name=create_job3&mode=copy&from=create_job1" --cookie "${cookie_file}" -X POST -H "${jenkins_crumb}"
[root@mylinux1 ~]#
4、修改job
[root@mylinux1 ~]# curl -u "${username_password}" "${jenkins_url}/job/create_job2/config.xml" --cookie "${cookie_file}" -X POST -H "${jenkins_crumb}" -H 'Content-Type:text/xml' --data-binary "@./config.xml"
[root@mylinux1 ~]#
5、無參構(gòu)建
[root@mylinux1 ~]# curl -u "${username_password}" "${jenkins_url}/job/build_no_params/build" --cookie "${cookie_file}" -X POST -H "${jenkins_crumb}"
[root@mylinux1 ~]#
6、有參構(gòu)建
[root@mylinux1 ~]# curl -u "${username_password}" "${jenkins_url}/job/build_with_params/buildWithParameters" --cookie "${cookie_file}" -X POST -H "${jenkins_crumb}" --data-urlencode json='{"env":"dev"}'
7、刪除job
[root@mylinux1 ~]# curl -u "${username_password}" "${jenkins_url}/job/create_job2/doDelete" --cookie "${cookie_file}" -X POST -H "${jenkins_crumb}"
六、使用curl調(diào)用 操作指定構(gòu)建的Job
查看最新構(gòu)建任務(wù)編號
curl -u USERNAME:PASSWORD “JENKINSURL:PORT/job/son_demo/lastBuild/buildNumber”
查看某次構(gòu)建控制臺日志
curl -u USERNAME:PASSWORD “JENKINSURL:PORT/job/JOBNAME/ID/logText/progressiveText”
刪除某次構(gòu)建curl -u USERNAME:PASSWORD "JENKINSURL:PORT/job/JOBNAME/ID/doDelete" -X POST --cookie "${cookie_file}" -H "${jenkins_crumb}"
1、查看最新構(gòu)建任務(wù)編號
[root@mylinux1 ~]# curl -u "${username_password}" "${jenkins_url}/job/build_with_params/lastBuild/buildNumber"
5[root@mylinux1 ~]#
2、查看某次構(gòu)建控制臺日志
[root@mylinux1 ~]# curl -u "${username_password}" "${jenkins_url}/job/build_with_params/6/logText/progressiveText"Started by user admin
Running as SYSTEM
Building on the built-in node in workspace /var/jenkins_home/workspace/build_with_params
[build_with_params] $ /bin/sh -xe /tmp/jenkins11717514708564825855.sh
+ [ online = dev ]
+ [ online = test ]
+ [ online = online ]
+ echo online runtime
online runtime
Finished: SUCCESS
[root@mylinux1 ~]#
3、刪除某次構(gòu)建
七、Python Jenkins Api常用接口操作
1、安裝 pip install jenkinsapi
2、jenkinsapi 連接Jenkins服務(wù)
from jenkinsapi import jenkins
class JenkinsApiStudy:
def __init__(self):
"""
實(shí)現(xiàn)對jenkins的連接
"""
jenkins_url="http://192.168.22.3:8080"
#username="admin"
#password="admin"
用戶名="admin"
密碼="admin"
self.my_jenkins = jenkins.Jenkins(jenkins_url, username, password, use_crumb=True)
3、jenkinsapi 獲取所有jobs
def get_all_jobs(self):
"""
jenkinsapi 獲取所有jobs
:return:
"""
jobs=[]
# 需要注意,如果請求的url與Jenkins Location配置的Jenkins URL不一致時,獲取到的key會拼接上一截地址
#jobs=self.my_jenkins.keys() # 獲取所有的job名稱
for info in self.my_jenkins.get_jobs_info():
jobs.append(info) # 獲取job的url與名稱 比較卡
return jobs
4、jenkinsapi 獲取構(gòu)建隊(duì)列
def get_queue(self):
"""
獲取隊(duì)列信息
:return:
"""
return self.my_jenkins.get_queue().keys()
5、jenkinsapi 獲取Job信息
def get_job_info(self,job_name):
"""
jenkinsapi 獲取Job信息
:return:
"""
# 獲取job對象
my_job=self.my_jenkins.get_job(job_name)
# 獲取最后一次構(gòu)建對象
print(my_job.get_last_build())
# 獲取最后一次完成的構(gòu)建對象
print(my_job.get_last_completed_build())
# 獲取最后一次成功的構(gòu)建對象
print(my_job.get_last_good_build())
# 獲取最后一次失敗的構(gòu)建編號
print(my_job.get_last_failed_buildnumber())
6、jenkinsapi 操作Job信息
def deal_job(self,job_name):
"""
jenkinsapi 操作Job信息
:param job_name: job名稱
:return:
"""
#my_job = self.my_jenkins.get_job(job_name)
# 獲取job的config
#print(my_job.get_config())
# 創(chuàng)建job
# 先獲取到j(luò)ob的config
with open(f"{job_name}_config.xml", "w", encoding="utf-8") as f:
my = self.my_jenkins.get_job(job_name).get_config()
f.write(my)
self.my_jenkins.create_job("create_python_job", open("./build_no_params_config.xml", encoding="utf-8").read())
# 復(fù)制job
self.my_jenkins.copy_job(job_name, "build_no_params_job1")
#todo 禁用job:當(dāng)創(chuàng)建job或者復(fù)制job時,會出現(xiàn)job沒有構(gòu)建功能;操作:禁用后再操作啟用
#my_job.disable()
# 啟用job
#my_job.enable()
# 重命名job
self.my_jenkins.rename_job(job_name, f"{job_name}_new")
# 無參構(gòu)建
self.my_jenkins.build_job(job_name)
# 有參構(gòu)建
self.my_jenkins.build_job(job_name, params={"env": "test"})
# 刪除job
#self.my_jenkins.delete_job(job_name)
a、查看my_job.get_config()信息
b、查看生成的config.xml文件
def deal_job(self,job_name):
"""
jenkinsapi 操作Job信息
:param job_name: job名稱
:return:
"""
#my_job = self.my_jenkins.get_job(job_name)
# 獲取job的config
#print(my_job.get_config())
# 創(chuàng)建job
# 先獲取到j(luò)ob的config
with open(f"{job_name}_config.xml", "w", encoding="utf-8") as f:
my = self.my_jenkins.get_job(job_name).get_config()
f.write(my)
self.my_jenkins.create_job("create_python_job", open("./build_no_params_config.xml", encoding="utf-8").read())
文章來源:http://www.zghlxwxcb.cn/news/detail-440353.html
7、jenkinsapi 操作指定構(gòu)建的Job
def get_build_info(self,job_name,build_id=None):
"""
jenkinsapi 操作指定構(gòu)建的Job 獲取build信息
:param job_name: job名稱
:param build_id: 構(gòu)建id
:return:
"""
my_job = self.my_jenkins.get_job(job_name)
# 當(dāng)前job對象是否在隊(duì)列/構(gòu)建中
print(my_job.is_queued_or_running())
# 獲取指定構(gòu)建ID的對象
build_object = my_job.get_build(build_id)
# 獲取構(gòu)建對象的時間戳
print(build_object.get_timestamp())
# 獲取控制臺日志
print(build_object.get_console())
# 獲取構(gòu)建參數(shù)
print(build_object.get_params())
# 獲取構(gòu)建的狀態(tài)
print(build_object.get_status())
# 獲取構(gòu)建的變更日志
print(build_object.get_changeset_items())
# 刪除指定構(gòu)建
#my_job.delete_build(build_id)
輸出結(jié)果文章來源地址http://www.zghlxwxcb.cn/news/detail-440353.html
2023-04-16 05:52:26+00:00
Started by user admin
Running as SYSTEM
Building on the built-in node in workspace /var/jenkins_home/workspace/build_with_params
[build_with_params] $ /bin/sh -xe /tmp/jenkins12197874264732667620.sh
+ [ test = dev ]
+ [ test = test ]
+ echo test runtime
test runtime
Finished: SUCCESS
{'env': 'test'}
SUCCESS
[]
8、整合以上代碼
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# @Time : 2023/4/16 21:47
# @Author : 杜蘭特
# @File : jenkins_api_study.py
from jenkinsapi import jenkins
class JenkinsApiStudy:
def __init__(self):
"""
實(shí)現(xiàn)對jenkins的連接
"""
jenkins_url="http://192.168.22.3:8080"
#username="admin"
#password="admin"
用戶名="admin"
密碼="admin"
self.my_jenkins = jenkins.Jenkins(jenkins_url, username, password, use_crumb=True)
def get_all_jobs(self):
"""
jenkinsapi 獲取所有jobs
:return:
"""
jobs=[]
# 需要注意,如果請求的url與Jenkins Location配置的Jenkins URL不一致時,獲取到的key會拼接上一截地址
#jobs=self.my_jenkins.keys() # 獲取所有的job名稱
for info in self.my_jenkins.get_jobs_info():
jobs.append(info) # 獲取job的url與名稱 比較卡
return jobs
def get_queue(self):
"""
獲取隊(duì)列信息
:return:
"""
return self.my_jenkins.get_queue().keys()
def get_job_info(self,job_name):
"""
jenkinsapi 獲取Job信息
:return:
"""
# 獲取job對象
my_job=self.my_jenkins.get_job(job_name)
# 獲取最后一次構(gòu)建對象
print(my_job.get_last_build())
# 獲取最后一次完成的構(gòu)建對象
print(my_job.get_last_completed_build())
# 獲取最后一次成功的構(gòu)建對象
print(my_job.get_last_good_build())
# 獲取最后一次失敗的構(gòu)建編號
print(my_job.get_last_failed_buildnumber())
def deal_job(self,job_name):
"""
jenkinsapi 操作Job信息
:param job_name: job名稱
:return:
"""
my_job = self.my_jenkins.get_job(job_name)
# 獲取job的config
print(my_job.get_config())
# 創(chuàng)建job
# 先獲取到j(luò)ob的config
# with open(f"{job_name}_config.xml", "w", encoding="utf-8") as f:
# my = self.my_jenkins.get_job(job_name).get_config()
# f.write(my)
#self.my_jenkins.create_job("create_python_job", open("./build_no_params_config.xml", encoding="utf-8").read())
# 復(fù)制job
# self.my_jenkins.copy_job(job_name, "build_no_params_job1")
#todo 禁用job:當(dāng)創(chuàng)建job或者復(fù)制job時,會出現(xiàn)job沒有構(gòu)建功能;操作:禁用后再操作啟用
#my_job.disable()
# # 啟用job
#my_job.enable()
# 重命名job
# self.my_jenkins.rename_job(job_name, f"{job_name}_new")
# 無參構(gòu)建
# self.my_jenkins.build_job(job_name)
# 有參構(gòu)建
# self.my_jenkins.build_job(job_name, params={"env": "test"})
# # 刪除job
#self.my_jenkins.delete_job(job_name)
def get_build_info(self,job_name,build_id=None):
"""
jenkinsapi 操作指定構(gòu)建的Job 獲取build信息
:param job_name: job名稱
:param build_id: 構(gòu)建id
:return:
"""
my_job = self.my_jenkins.get_job(job_name)
# 當(dāng)前job對象是否在隊(duì)列/構(gòu)建中
print(my_job.is_queued_or_running())
# 獲取指定構(gòu)建ID的對象
build_object = my_job.get_build(build_id)
# 獲取構(gòu)建對象的時間戳
print(build_object.get_timestamp())
# 獲取控制臺日志
print(build_object.get_console())
# 獲取構(gòu)建參數(shù)
print(build_object.get_params())
# 獲取構(gòu)建的狀態(tài)
print(build_object.get_status())
# 獲取構(gòu)建的變更日志
print(build_object.get_changeset_items())
# 刪除指定構(gòu)建
#my_job.delete_build(build_id)
if __name__ == '__main__':
jk=JenkinsApiStudy()
#print(jk.get_all_jobs())
#print(jk.get_queue())
#jk.get_job_info("python_interface_project")
#jk.deal_job("build_no_params")
jk.get_build_info("build_with_params",10)
到了這里,關(guān)于【實(shí)戰(zhàn)】jenkins api 接口的文章就介紹完了。如果您還想了解更多內(nèi)容,請?jiān)谟疑辖撬阉鱐OY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章,希望大家以后多多支持TOY模板網(wǎng)!