Jenkins 常用 REST API介绍(Java 客户端)

转载：https://blog.csdn.net/weixin_34101784/article/details/91394930

背景

Jenkins 作为项目构建,持续部署必不可少的工具,如何使用程序或者脚本来控制构建流程成为本文研究的内容.

默认情况下,安装好Jenkins后,/api路径下面有一些基本 api 的介绍,可供参考,但是不是很直观,没有罗列出 api 接口.

本文使用的 jenkins-java 客户端是:

1. <dependency>

2. <groupId>com.offbytwo.jenkins</groupId>

3. <artifactId>jenkins-client</artifactId>

4. <version>0.3.7</version>

5. </dependency>

6. 复制代码

假设 jenkins 部署地址为: http://localhost:8080

本文用到的 api:

名称	API
创建 Job	POST http://localhost:8080/createItem/api/json?name=xxx
更新 Job	POST http://localhost:8080/job/{job_name}/config.xml/api/json
获取 Job	GET http://localhost:8080/job/{job_name}/api/json
获取 JobXml	GET http://localhost:8080/job/{job_name}/config.xml/api/json
创建 Build	POST http://localhost:8080/job/{job_name}/build/api/json
获取 QueueItem	GET http://localhost:8080/queue/item/17/api/json
获取 Build信息	GET http://localhost:8080/job/test/6/api/json
获取TXT日志	GET http://localhost:8080/job/test/{build_number}/logText/progressiveText/api/json
获取 Html 日志	GET http://localhost:8080/job/test/{build_number}/logText/progressiveHtml/api/json

创建 Job API

jenkins 的配置都是靠 xml 的格式落地的,所以配置其实都是 xml 的形式.

1. POST http://localhost:8080/createItem/api/json?name=xxx

2. 复制代码

将创建需要的 config.xml也用请求传入到服务端,既可以创建成功.

如何知道 config.xml应该如何编写呢?

• 可以在 jenkins 收工创建一个需要的项目,然后编辑完成后,到 jenkins 工作目录下 找到 jobs/{job_name}/config.xml 用他作为模板来书写你需要的模板.
• 通过获取 xml 的 api 来获取

1. GET http://localhost:8080/job/{job_name}/config.xml/api/json

2. 复制代码

Java Client

1. jenkinsServer.createJob("auto_test_job", replacedText, true);

2. String xml = jenkinsServer.getJobXml("auto_test_job");

3. 复制代码

修改 Job API

修改 job 也是修改xml.

1. POST http://localhost:8080/job/{job_name}/config.xml/api/json

2. 复制代码

config.xml的内容传入到 body 中,contentType 设置为text/xml

Java Client

1. jenkinsServer.updateJob("auto_test_job", replacedText, true);

2. 复制代码

构建 Build API

根据 job 名称获取 Job

1. GET http://localhost:8080/job/{job_name}/api/json

2. 复制代码

新的构建

1. POST http://localhost:8080/job/{job_name}/build/api/json

2. 复制代码

提交到服务器成功后返回一个类似于队列ID的东西,因为是异步构建,那么要获取构建的状态,就需要,用这个队列 id去进一步的获取. 例如:

1. $ curl -v -XPOST http://localhost:8080/job/test/build/api/json

2. * Trying ::1...

3. * TCP_NODELAY set

4. * Connected to localhost (::1) port 8080 (#0)

5. > POST /job/test/build/api/json HTTP/1.1

6. > Host: localhost:8080

7. > User-Agent: curl/7.54.0

8. > Accept: */*

9. >

10. < HTTP/1.1 201 Created

11. < Date: Sat, 05 Jan 2019 08:33:45 GMT

12. < X-Content-Type-Options: nosniff

13. < Location: http://localhost:8080/queue/item/17/

14. < Content-Length: 0

15. < Server: Jetty(9.4.z-SNAPSHOT)

16. <

17. * Connection #0 to host localhost left intact

18. 复制代码

上面的Location: http://localhost:8080/queue/item/17/就是返回的队列信息,下面的 queueItem 获取就是依赖这个.

根据 QueueId 获取 QueueItem

1. GET http://localhost:8080/queue/item/17/api/json

2. 复制代码

举例

1. $ curl http://localhost:8080/queue/item/17/api/json\?pretty\=true

2. {

3. "_class" : "hudson.model.Queue$LeftItem",

4. "actions" : [

5. {

6. "_class" : "hudson.model.CauseAction",

7. "causes" : [

8. {

9. "_class" : "hudson.model.Cause$UserIdCause",

10. "shortDescription" : "由用户 anonymous 启动",

11. "userId" : null,

12. "userName" : "anonymous"

13. }

14. ]

15. }

16. ],

17. "blocked" : false,

18. "buildable" : false,

19. "id" : 17,

20. "inQueueSince" : 1546677225670,

21. "params" : "",

22. "stuck" : false,

23. "task" : {

24. "_class" : "hudson.maven.MavenModuleSet",

25. "name" : "test",

26. "url" : "http://localhost:8080/job/test/",

27. "color" : "blue"

28. },

29. "url" : "queue/item/17/",

30. "why" : null,

31. "cancelled" : false,

32. "executable" : {

33. "_class" : "hudson.maven.MavenModuleSetBuild",

34. "number" : 6,

35. "url" : "http://localhost:8080/job/test/6/"

36. }

37. }

38. 复制代码

获取到的 QueueItem 上面就知道这个 item 有没有被 build 执行,比较关键的参数就是executable,如果executable不为空,就说明 jenkins 已经在对这个任务进行 build 的了,build 的编号就是number,也就是我们在 jenkins 页面上看到的编号.你可以通过url字段的值在浏览器打开.

获取 Build 详情

既然开始了 build,我们就可以获取 build 的详细信息.

1. curl http://localhost:8080/job/test/6/api/json\?pretty\=true

2. {

3. ...

4. "building" : false,

5. "description" : null,

6. "displayName" : "#6",

7. "duration" : 13631,

8. "estimatedDuration" : 17999,

9. "executor" : null,

10. "fullDisplayName" : "test #6",

11. "id" : "6",

12. "keepLog" : false,

13. "number" : 6,

14. "queueId" : 17,

15. "result" : "SUCCESS",

16. "timestamp" : 1546677234794,

17. "url" : "http://localhost:8080/job/test/6/",

18. "builtOn" : "",

19. ...

20. }

21. 复制代码

从返回结果可以看到 是否还在 build:"building" : false,,如果 build 结束状态就在:"result" : "SUCCESS",

获取Build日志

文本:

1. GET http://localhost:8080/job/test/{build_number}/logText/progressiveText/api/json

2. 复制代码

html

1. GET http://localhost:8080/job/test/{build_number}/logText/progressiveHtml/api/json

2. 复制代码

Java Client

1.  

2. JobWithDetails job = jenkinsServer.getJob(jenkinsJob);

3. ...

4. QueueReference reference = job.build( true);

5. ...

6. QueueItem queueItem = jenkinsServer.getQueueItem(new QueueReference(queuePart));

7. ...

8. Build build = jenkinsServer.getBuild(queueItem);

9. ...

10. BuildWithDetails details = build.details();

11. BuildResult result = details.getResult();

12. ...

13. String logs = details.getConsoleOutputText();

14.