SonarQube通过Web API更新规则失败问题求助

我之前也踩过SonarQube API更新规则的坑，400 Bad Request这种“看起来啥都对但就是不行”的错误真的磨人。结合你说的情况——只传markdown_note和key能成功，一加严重性、描述这些字段就失败，大概率是这几个方面出了问题：

1. 先揪出最容易犯的拼写错误 #

你提到的参数名是Serverity，这很可能是第一个坑！SonarQube API里的正确参数名是**severity**（小写开头，而且是"e"结尾，不是"er"）。类似的，修复函数的参数是remediationFunction，要检查大小写和拼写是否完全和文档一致，哪怕一个字母错了都会触发400。

2. 参数值必须符合SonarQube的严格规范 #

SonarQube对很多字段的取值有硬性要求，传错就会报错：

• Severity：只能是BLOCKER、CRITICAL、MAJOR、MINOR、INFO这五个大写值，不能自定义或者用小写。
• Remediation Function：可选值是CONSTANT、LINEAR、LINEAR_OFFSET，而且如果选了LINEAR或LINEAR_OFFSET，必须配套传remediationCost参数（比如remediationCost=10min），缺一不可。
• Description：注意！不是所有规则都允许修改描述！SonarQube的内置规则（比如SonarSource官方提供的规则）的描述是只读的，只有你自己创建的自定义规则，或者某些允许编辑的社区规则，才能修改description字段。如果你改的是内置规则，传这个字段直接就会400。

3. 检查请求格式和参数结构 #

确保你的POST请求用了正确的Content-Type：如果是传JSON体，必须设置Content-Type: application/json；如果是form-data格式，要确保所有参数都在顶级层级，没有嵌套错误。

给你一个能正常工作的请求示例（JSON格式）：

{
  "key": "custom:my-rule-key",
  "severity": "MAJOR",
  "description": "This is my updated rule description",
  "remediationFunction": "LINEAR",
  "remediationCost": "5min",
  "markdown_note": "Updated rule note"
}

4. 看SonarQube日志找具体错误 #

400错误只是表面现象，SonarQube的后台日志（通常在sonarqube/logs/web.log里）会给出更详细的错误信息，比如“参数severity取值无效”或者“无法修改内置规则的description字段”。直接看日志能帮你快速定位到底是哪个字段出了问题。

最后总结排查步骤 #

1. 核对所有参数名的拼写和大小写，确保和API文档完全一致；
2. 验证每个参数的取值是否符合SonarQube的规范，尤其是severity和修复函数；
3. 确认你要修改的规则是否允许编辑目标字段（比如内置规则的description不能改）；
4. 检查是否遗漏了配套参数（比如修复函数对应的remediationCost）；
5. 查看SonarQube的web.log日志，获取具体错误详情。

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