Python调用Jenkins API的正确使用姿势

 

当需要批量获取Jenkins上Job的信息时，可以通过Python调用API的方式获取信息，然后再对返回的结果进行分析转化，得到自己想要的结果。

 

1、Python模块包

pip3 install python-jenkins

 

2、登陆方式

1）明文

server = jenkins.Jenkins(url,username,password)

 

2）token

url = https://username:token@url
server = jenkins.Jenkins(url)

 

3、实例

import jenkins
url = 'https://username:token@url'
# 登陆jenkins
server = jenkins.Jenkins(url)
# 获取jenkins的版本
version = server.get_version()
print(version)

 

4、常用查询接口

1）get_job_info(name, depth=0, fetch_all_builds=False)  获取指定Job的详细信息 
2）get_job_info_regex(pattern, depth=0, folder_depth=0) 获取匹配指定Job的详细信息
3）get_job_name(name) 获取指定名字的Job，常用于判断Job是否存在
4）get_jobs()获取所有的jobs
5）debug_job_info(job_name) 以可读的方式打印Job信息
6）get_version()获取Jenkins版本信息
7）get_views() 获取所有的视图

 

5、写在最后

李先生（Lemon），高级运维工程师（自称），SRE专家（目标），梦想在35岁买一辆保时捷。喜欢钻研底层技术，认为底层基础才是王道。一切新技术都离不开操作系统（CPU、内存、磁盘）、网络等。坚持输入输出，记录自己学习的点滴，在平凡中坚持前行，总有一天会遇见不一样的自己。公众号：运维汪（ID：Leeeee_Li）。

 

官方文档：
https://www.jenkins.io/doc/book/using/remote-access-api/
https://python-jenkins.readthedocs.io/en/latest/api.html