SonarQube api设置比较 SonarQube api查询返回数据超过10000报错

品牌型号：联想 E550C ThinkPad

系统：Windows 11

软件版本：SonarQube Server 25

SonarQube基于其强大的代码扫描分析能力和直观的分析报告，能快速得知代码中存在的漏洞和安全问题并及时进行修复。同时，SonarQube不仅提供了丰富的Web界面功能，还开放了完善的Web API接口，使用户能轻松在外部系统中调用SonarQube功能。但在实际应用中，许多用户调用API却遇到诸多限制，不过无须担心，本文就遇到的主要问题，向大家讲述该如何进行SonarQube api设置比较，SonarQube api查询返回数据超过10000报错怎么解决。

一、SonarQube api设置比较

SonarQube服务端提供了丰富的API用于从应用程序或脚本中与系统交互，当前较新版本为Web API v2版本，旧Web API版本的接口正在被逐步弃用和替换，以下是关于两个版本API方面的比较：

点击用户头像旁的图标按钮，展开文档菜单，在其中可以分别进入Web API文档和Web API v2文档。

Web API v2文档界面如图2，整体将全部API分为了user-management、system、dop-translation、clean-code-policy、authorization、analysis六大类，并按照“/api/v2/类别/功能”的URL形式供用户调用。

而在Web API中，则按照“api/功能”的URL形式供用户调用，且不同的接口有不同的最低SonarQube版本要求，如图中“api/alm_integrations/list_azure_projects”接口要求最低版本为8.6。

值得一提的是，目前有部分Web API接口未迁移至Web API v2中，如问题issues接口，因此对一些常用接口的使用仍要采用Web API版本。

二、SonarQube api查询返回数据超过10000报错

有了上述API接口，日常使用时，就十分方便使用API查询一些与项目相关的数据，如执行类似“/api/issues/search”这样的问题数据查询接口，查询项目错误详情。

但当API要查询的数量超过10000条时，就会报出错误响应，这是因为SonarQube的查询引擎是采用“elasticsearch”全局搜索引擎来实现，而elasticsearch默认的最大返回数据就是10000条。

此时可以打开elasticsearch的config文件夹，打开“elasticsearch.yml”配置文件，在其中添加一行“max_result_window: 20000”配置，将窗口最大返回数量调整为20000，这样就可以增加查询返回数据数量，最后重启SonarQube应用生效。

除了调整配置外，建议大家在调用API时增加分页查询机制，SonarQube在很多查询API中都提供了“p”和“ps”接口参数，前者表示从第几页开始查询，后者表示每页的数据数量，如可以通过“/api/issues/search?p=1&ps=200”一次性只查询200条数据，分多次查询，这样即减少了服务器端压力，也能顺利返回查询数据。

通过本文的说明，大家可以了解到与SonarQube api设置比较，SonarQube api查询返回数据超过10000报错的相关信息。SonarQube的常规接口在废弃后可以有半年的继续使用时长，半年后将被彻底删除，因此如果要在外部程序中集成API接口，那么就要做好接口的错误处理，同时也要及时跟进接口的更新内容，并进行相应修改。