Jenkins REST API 完全手册——下篇

Jenkins REST API

API相关说明介绍见Jenkins REST API 完全手册——上篇

CrumbIssuer 系统哈希值信息（用于防御CSRF攻击）

使用 CrumbIssuer 防御 CSRF 攻击

• CrumbIssuerApi

• path: /crumbIssuer/api/xml

crumb

GET http://127.0.0.1:8080/crumbIssuer/api/xml?{key}={value}

1. 参数

key	value
xpath	concat(//crumbRequestField,":",//crumb)

2. 返回类型：Crumb

字段	类型
value	String
errors	List<Error>

PluginManager 插件管理（插件信息、安装插件）

• PluginManagerApi
• path: /pluginManager

plugins 插件列表

GET http://127.0.0.1:8080/pluginManager/api/json

• 返回类型：List<Plugin>

字段	类型	说明
active	Boolean
backupVersion	String
bundled	Boolean
deleted	Boolean
downgradable	Boolean
enabled	Boolean
longName	String
……

installNecessaryPlugins 安装插件

POST http://127.0.0.1:8080/pluginManager/installNecessaryPlugins

1. 参数

payload: <jenkins><install plugin="{pluginID}"/></jenkins>

字段	说明
{pluginID}	要安装的插件ID

2. 返回类型：RequestStatus

Queue 任务队列相关（队列状态）

• QueueApi
• path: /queue

queue 所有任务队列信息

GET http://127.0.0.1:8080/queue/api/json

返回类型：List<QueueItem>

字段
blocked	Boolean	是否阻塞
buildable	Boolean	是否可构建
id	Integer
inQueueSince	Long
params	Map<String, String>	任务参数
task	Task	Task中包含任务名称和URL
……

item 任务队列信息

GET http://127.0.0.1:8080/queue/item/{queueId}/api/json

1. 参数

字段	说明
{queueId}	任务队列ID

2. 返回类型：QueueItem

cancel 取消任务队列

POST http://127.0.0.1:8080/cancelItem?id={id}

1. 参数

字段	说明
{id}	任务队列ID

2. 返回类型：RequestStatus

Statistics 统计信息

• StatisticsApi
• path: /

overall-load

GET http://127.0.0.1:8080/overallLoad/api/json

返回类型：OverallLoad

字段	类型	说明
availableExecutors	Map<String, String>
busyExecutors	Map<String, String>
connectingExecutors	Map<String, String>
definedExecutors	Map<String, String>
idleExecutors	Map<String, String>
onlineExecutors	Map<String, String>
queueLength	Map<String, String>
totalExecutors	Map<String, String>
totalQueueLength	Map<String, String>

System 系统信息

SystemInfo 系统信息

path: /

返回类型：SystemInfo

字段	类型	说明
hudsonVersion	String
jenkinsVersion	String
jenkinsSession	String
instanceIdentity	String
sshEndpoint	String
server	String