查看 API 文檔

Jenkins API 沒有統一的入口,而是采用 …/api/ 的 REST API 樣式。其中,"…" 表示 Jenkins 資源的 URL。常見的資源包括:站點(實例)、Job 和 Build。可以通過 URL 地址查看 API 信息,例如:

API 訪問方式

一般情況下,Jenkins API 支持 JSON、XML 和 Python API 三種訪問方式。以下是一些示例代碼:

# JSON 格式示例
import requests
response = requests.get('http:///api/json')
data = response.json()

使用方法

站點 API

通過站點 API 可以獲取 Jenkins 實例中的所有 job 信息,支持 JSON 和 XML 格式。以下是一些常用的 API:

- 獲取所有 job 信息(JSON 格式):http:///api/json?pretty=true
- 獲取所有 job 信息(XML 格式):http:///api/xml
- 重啟站點: http:///restart

獲取 Job 相關信息

可以通過 Job API 獲取指定 Job 的詳細信息,包括 builds 節點信息。

- 獲取當前 API 說明:http:///job//api/
- 獲取 Job 的 builds 節點信息:http:///job//api/json?pretty=true&tree=builds[*]

獲取指定 Build 相關信息

通過 Build API 可以獲取指定構建的詳細信息。

- 獲取指定構建信息(JSON 格式):http:///job///api/json?pretty=true

Python API Wrappers

Jenkins 提供了多種 Python API 封裝庫,例如 jenkinsapi 和 python-jenkins。這些庫可以幫助開發者更方便地與 Jenkins API 進行交互。

遠程觸發 Job

通過 API 可以遠程觸發 Jenkins Job,以下是使用 curl 工具的一個示例:

# 使用 curl 觸發 Jenkins Job
crumb=$(curl -k -u ":" 'http:///crumbIssuer/api/xml?xpath=concat(//crumbRequestField,":",//crumb)')
curl -u ":" -H $crumb -X POST -s http:///buildWithParameters?token=testuser

API 觸發示例

參考文獻

通過 Jenkins API,開發者可以高效地管理 Jenkins 實例,實現自動化的 CI/CD 流程。

FAQ

問:什么是 Jenkins API,它的主要功能是什么?

問:如何查看 Jenkins API 文檔?

問:Jenkins API 支持哪幾種訪問方式?

問:如何通過 Jenkins API 獲取所有 Job 的信息?

問:哪些 Python 庫可以幫助與 Jenkins API 交互?

上一篇:

MinIO API文檔快速入門

下一篇:

用RESTAPI遠程訪問你的Jenkins
#你可能也喜歡這些API文章!

我們有何不同?

API服務商零注冊

多API并行試用

數據驅動選型,提升決策效率

查看全部API→
??

熱門場景實測,選對API

#AI文本生成大模型API

對比大模型API的內容創意新穎性、情感共鳴力、商業轉化潛力

25個渠道
一鍵對比試用API 限時免費

#AI深度推理大模型API

對比大模型API的邏輯推理準確性、分析深度、可視化建議合理性

10個渠道
一鍵對比試用API 限時免費