如何通过tree或depth参数单次HTTP请求获取所有Jenkins任务？

我当前使用的Jenkins实例包含约800个任务，目录结构是多层嵌套文件夹，各层级都有任务（这个配置没法调整）。现在我在Node.js环境里通过Jenkins API获取这些任务的信息。

我试过两种可行但有问题的方案：

• 从根目录递归调用目录结构，检查_class为workflowjob的任务，用tree=jobs[*]获取文件夹内的apiURL和任务；
• 设置足够大的depth=N参数，一次性把所有信息获取成单个JSON对象。

第一种方案在Jenkins规模小时没问题，但请求太多会导致实例故障；第二种方案能批量获取，但目录结构可能变化，硬编码N值不灵活，而且返回的JSON解析难度高。

我还试过用tree=jobs[*]{n, n-1}限制任务数量，但因为要保留所有任务，这个方案不适用；也试过Groovy脚本，但不确定能不能和Node.js环境良好集成。

请问有没有更优的REST API方案解决这个问题？

推荐解决方案 #

1. 动态计算目录深度（替代硬编码depth=N）

先发起轻量请求获取根目录的文件夹层级框架，只拿文件夹的apiUrl和类型信息，不请求任务详情：

GET /api/json?tree=jobs[name,apiUrl,_class]

遍历返回结果，标记所有_class为文件夹类型（比如com.cloudbees.hudson.plugins.folder.Folder）的节点，递归收集所有层级的文件夹路径，统计出最大目录深度。之后用这个动态计算出的深度值设置depth参数，一次性获取全量数据，避免硬编码的局限性。

2. 精准控制tree参数，减少冗余数据

不需要返回所有字段，用tree参数指定仅获取你需要的任务属性，降低返回数据体积和解析难度。比如只获取任务名称、URL、类型：

GET /api/json?depth=动态计算的深度值&tree=jobs[*[jobs[*[jobs[...]]]{name,url,_class}]]

这里的嵌套结构可以根据动态计算的层级自动生成，确保覆盖所有嵌套文件夹，同时只拉取必要字段，简化解析工作。

3. 分批次请求平衡压力

如果全量请求数据还是过大，可以把任务按文件夹分组，分批次请求不同文件夹的内容。比如先获取所有一级文件夹的apiUrl，然后控制并发数（比如同时请求5-10个）并行拉取这些文件夹的任务信息，再递归处理子文件夹。这种方式比全递归请求的总请求数少，同时不会因为单次请求数据量过大给Jenkins造成过高压力。

4. Groovy脚本与Node.js集成的可行方式

Groovy脚本可以通过Jenkins的/scriptText API直接执行，由Jenkins内部递归处理所有任务，返回结构化的JSON数据，Node.js只需发起一次请求：

// Node.js示例代码
const axios = require('axios');

async function getAllJobs() {
  const groovyScript = `
    def getAllJobsRecursive(folder) {
      def jobs = []
      folder.items.each { item ->
        if (item.class.simpleName == 'WorkflowJob') {
          jobs.add([name: item.name, url: item.url, fullName: item.fullName])
        } else if (item.class.simpleName == 'Folder') {
          jobs.addAll(getAllJobsRecursive(item))
        }
      }
      return jobs
    }
    return getAllJobsRecursive(Jenkins.instance)
  `;

  const response = await axios.post('http://your-jenkins-url/scriptText', {
    script: groovyScript
  }, {
    auth: { username: 'your-user', password: 'your-token' }
  });

  return JSON.parse(response.data);
}

这种方式只需要一次请求，返回的是干净的任务列表，Node.js解析起来非常简单，也不会给Jenkins造成过多请求压力。

内容的提问来源于stack exchange，提问作者barr3ra