Jenkins 的 REST API 可以从外部调用 Jenkins 实例,一些库例如 jenkins-rest 和 java-client-api 封装了相关 API,可以在 Java 中操作 Jenkins 。
本文参考 jenkins-rest 库将 API 根据获取的资源类型不同分为 6 个类别。
API类型 | 说明 |
---|---|
JobsAPI | 任务管理(任务信息、创建、修改) |
PluginManagerAPI | 插件管理(插件信息、安装插件) |
QueueAPI | 任务队列相关(队列状态) |
StatisticsAPI | Jenkins统计信息 |
CrumbIssuerAPI | 系统哈希值信息(用于防御CSRF攻击) |
SystemAPI | Jenkins系统状态(版本、路径) |
本文介绍其中 JobsAPI 。
其余 API 请见 Jenkins REST API 完全手册——下篇
- 术语定义
名词 | 说明 |
---|---|
job | 任务 |
payload | 在POST请求中提交的数据 |
{optionalFolderPath} | 可选参数:任务所在目录的路径 |
{name} | 必须参数:任务名称 |
- 注意:在 GET/POST 时需要附加 HTTP 认证才能访问 API
- 本文使用的数据结构可以在 jenkins-rest/domain 中查看详细定义
Jobs 相关 API
job-info 获取任务信息
GET