### 调用Jenkins API远程触发Job任务 以下是通过 Python 使用 `jenkins` 库来实现远程触发 Jenkins Job 的方法。此过程涉及安装必要的库、连接到 Jenkins 实例以及执行特定的操作。 #### 安装依赖 为了使用 Jenkins API，在 Python 中可以借助第三方库 `python-jenkins` 来完成操作。可以通过以下命令安装该库： ```bash pip install python-jenkins ``` --- #### 远程触发 Jenkins Job 示例代码 下面是一个完整的示例代码，展示如何通过 Python 和 Jenkins API 触发一个带有参数的 Job 构建任务。 ```python import jenkins # 初始化 Jenkins 对象并提供 URL 和认证信息 server = jenkins.Jenkins('http://your.jenkins.server', username='your_username', password='your_password') # 获取指定 Job 的最后构建号 (可选) try: last_build_number = server.get_job_info('job_name')['lastBuild']['number'] print(f"Last build number of 'job_name': {last_build_number} [^3]") except Exception as e: print(f"No previous builds found or error occurred: {e}") # 参数化构建 - 如果需要传递参数给 Job，则定义参数字典 parameters = { 'param1': 'value1', 'param2': 'value2' } # 执行带参数的构建任务 next_build_number = server.build_job('job_name', parameters) print(f"Triggered build for 'job_name'. Next build number is expected to be: {next_build_number}") ``` 上述代码实现了以下几个功能： - 创建了一个与 Jenkins 服务器交互的对象实例。 - 可选地查询目标 Job 的最后一次构建编号。 - 提供了一组参数用于触发参数化的 Job 构建任务。 如果不需要传递任何参数，可以直接调用无参版本的方法： ```python server.build_job('job_name') ``` --- #### 验证构建状态 在触发构建之后，还可以定期轮询以验证其运行状态或等待直到构建结束。例如： ```python while True: try: # 查询当前构建的状态 build_info = server.get_build_info('job_name', next_build_number) if build_info['result'] is not None: print(f"Build result: {build_info['result']}") # 输出最终结果 break except jenkins.NotFoundException: continue time.sleep(5) # 每隔 5 秒检查一次 ``` 以上逻辑会持续监控构建进度直至完成，并打印出最终的结果。 --- #### 替代方案：使用 HTTP 请求触发 Job 如果不希望通过 `python-jenkins` 库，也可以直接发送 HTTP 请求至 Jenkins Server。这种方式通常适用于简单的场景或者无法安装额外库的情况。 ```python import requests url = "http://your.jenkins.server/job/job_name/buildWithParameters" params = { 'token': 'YOUR_TOKEN', # 此 token 是预先配置好的安全令牌 'param1': 'value1', 'param2': 'value2' } auth = ('your_username', 'your_password') # 或者使用 API Token response = requests.post(url, params=params, auth=auth) if response.status_code == 201: print("Job triggered successfully.") else: print(f"Failed to trigger job. Status code: {response.status_code}, Response: {response.text}") ``` 这种方法基于 RESTful 接口设计，利用了 `curl` 类似的机制[^2]。 --- ### 注意事项 - **安全性**：建议为 Jenkins 用户设置专用权限，仅允许访问所需的资源。 - **Token 设置**：对于远程触发的任务，推荐启用全局安全选项中的“Trigger / Script Approval”，并通过配置生成的安全 Token 访问。 - **错误处理**：实际应用中应加入更完善的异常捕获和日志记录机制。 ---