Jenkins REST API 完全手册——上篇

Jenkins 的 REST API 可以从外部调用 Jenkins 实例,一些库例如 jenkins-restjava-client-api 封装了相关 API,可以在 Java 中操作 Jenkins 。

本文参考 jenkins-rest 库将 API 根据获取的资源类型不同分为 6 个类别。

API类型说明
JobsAPI任务管理(任务信息、创建、修改)
PluginManagerAPI插件管理(插件信息、安装插件)
QueueAPI任务队列相关(队列状态)
StatisticsAPIJenkins统计信息
CrumbIssuerAPI系统哈希值信息(用于防御CSRF攻击)
SystemAPIJenkins系统状态(版本、路径)

本文介绍其中 JobsAPI 。
其余 API 请见 Jenkins REST API 完全手册——下篇

  • 术语定义
名词说明
job任务
payload在POST请求中提交的数据
{optionalFolderPath}可选参数:任务所在目录的路径
{name}必须参数:任务名称
  • 注意:在 GET/POST 时需要附加 HTTP 认证才能访问 API
  • 本文使用的数据结构可以在 jenkins-rest/domain 中查看详细定义

Jobs 相关 API

job-info 获取任务信息

GET http://127.0.0.1:8080/{optionalFolderPath}job/{name}/api/json

  1. 返回类型:JobInfo
字段类型说明
descriptionString描述
nameString项目名称
urlboolean路径
buildableString是否可构建
buildsList<BuildInfo>构建记录
lastBuildBuildInfo上次构建记录

build-info 获取构筑信息

GET http://127.0.0.1:8080/{optionalFolderPath}job/{name}/{number}/api/json

  1. 返回类型:BuildInfo
字段类型说明
artifactsList<Artifact>artifacts
actionsLis<Action>actions
buildingboolean路径
descriptionString描述

create 使用 XML 文件创建任务

从 XML 文件中加载任务配置并创建任务

POST http://127.0.0.1:8080/{optionalFolderPath}createItem

  1. 参数
keyvalue
name任务名称
payloadXML配置文件
  1. 返回类型:RequestStatus
字段类型说明
valueBoolean
errorsList<Error>

get-config 获取任务配置文件

GET http://127.0.0.1:8080/{optionalFolderPath}job/{name}/config.xml

  1. 返回类型: String

update-config 更新任务配置文件

POST http://127.0.0.1:8080/{optionalFolderPath}job/{name}/config.xml

  1. 参数
字段说明
payloadXML配置文件
  1. 返回类型:Boolean

get-description 获取任务描述

GET http://127.0.0.1:8080/{optionalFolderPath}job/{name}/description

  1. 返回类型:String

set-description 设置任务描述

POST http://127.0.0.1:8080/{optionalFolderPath}job/{name}/description

  1. 参数
keyvalue
description描述
  1. 返回类型:Boolean

delete 删除任务

POST http://127.0.0.1:8080/{optionalFolderPath}job/{name}/doDelete

  1. 返回类型:RequestStatus

enable允许任务

POST http://127.0.0.1:8080/{optionalFolderPath}job/{name}/enable

  1. 返回类型:Boolean

disable 禁止任务

POST http://127.0.0.1:8080/{optionalFolderPath}job/{name}/disable

  1. 返回类型:Boolean

build 构建

POST http://127.0.0.1:8080/{optionalFolderPath}job/{name}/build

  1. 返回类型: IntegerResponse
字段类型说明
valueInteger
errorsList<Error>

build-with-params 使用参数创建任务

POST http://127.0.0.1:8080/{optionalFolderPath}job/{name}/buildWithParameters

  1. 参数
keyvalue
payloadMap<String, List<String>> properties
  1. 返回类型: IntegerResponse

last-build-number 获取上次构建序号

GET http://127.0.0.1:8080/{optionalFolderPath}job/{name}/lastBuild/buildNumber

  1. 返回类型:Integer

last-build-timestamp 获取上次构建时间戳

GET http://127.0.0.1:8080/{optionalFolderPath}job/{name}/lastBuild/buildTimestamp

  1. 返回类型:String

progressive-text 获取构建控制台输出

GET http://127.0.0.1:8080/{optionalFolderPath}job/{name}/lastBuild/logText/progressiveText

  1. 返回类型:ProgressiveText
字段类型说明
textString控制台输出
sizeInteger字数
hasMoreDataBoolean是否有更多数据
  • 2
    点赞
  • 27
    收藏
  • 2
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
©️2022 CSDN 皮肤主题:大白 设计师:CSDN官方博客 返回首页
评论 2
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、C币套餐、付费专栏及课程。

余额充值