Jenkins Blue Ocean REST API搜索运行时如何指定查询条件

问题描述

在使用Jenkins Blue Ocean REST API搜索运行时，想要根据Jenkins任务的参数进一步缩小搜索范围。目前，用户已经能够根据某个特定流水线进行搜索，但希望能够更精确地根据Jenkins任务参数进行搜索。用户已经了解到API返回的字段较基本，并且目前只能通过使用jq来处理JSON响应，但希望能有更好的方式来实现。

解决方案

在Jenkins Blue Ocean REST API中，虽然API默认返回的字段有限，但你仍然可以使用一些技巧来根据任务参数进行搜索。以下是一些解决方案，以帮助你实现更精确的搜索：

请注意以下操作可能会受到Jenkins版本差异的影响，确保你的版本与本解决方案相匹配。

方案1：使用jq处理JSON响应

目前，你已经能够使用jq来处理JSON响应，虽然这不是最理想的方式，但仍然可以帮助你在返回的有限字段中找到所需的信息。你可以进一步优化你的jq查询，以获取特定参数的值。以下是一个示例命令，它从JSON响应中提取pipeline和cause字段的值：

$ curl -k --silent "https://<SOME_SERVER>/blue/rest/search/?q=type:run;organization:jenkins;pipeline:<SOME_PIPELINE>;excludedFromFlattening:parameters" | jq '.[0] | {pipeline: .pipeline, cause: .causes[0].shortDescription}'

这个命令会提取第一个运行的pipeline和cause字段值。

方案2：自定义Jenkins Blue Ocean REST API查询

如果Jenkins Blue Ocean REST API默认的搜索功能无法满足你的需求，你可以考虑自定义一个脚本或工具，以根据任务参数进行更精确的搜索。以下是一个示例脚本，它使用Python和Jenkins API库来实现根据任务参数进行搜索：

import requests

jenkins_server = "<SOME_SERVER>"
pipeline_name = "<SOME_PIPELINE>"
jenkins_api_url = f"https://{jenkins_server}/blue/rest/search/?q=type:run;organization:jenkins;pipeline:{pipeline_name};excludedFromFlattening:parameters"

response = requests.get(jenkins_api_url)
data = response.json()

# 进一步处理数据，根据任务参数进行搜索
for run in data:
    pipeline = run.get('pipeline')
    cause = run.get('causes')[0].get('shortDescription')
    # 根据任务参数进行进一步筛选
    if pipeline == pipeline_name and cause == "<SOME_CAUSE>":
        print(run)

在这个示例中，我们使用Python的requests库来发送GET请求获取Jenkins Blue Ocean REST API的JSON响应。然后，我们进一步处理JSON数据，根据任务参数进行搜索。你可以根据实际需求，自定义脚本来满足更复杂的搜索条件。

注意事项

无论你选择使用哪种方法，都要确保你的Jenkins版本与解决方案相匹配，同时要注意API的权限和访问限制。

总结

通过使用jq进行JSON响应处理或自定义脚本来实现根据任务参数进行搜索，你可以更精确地在Jenkins Blue Ocean REST API中找到所需的运行。选择适合你需求的方法，根据实际情况进行调整。