- 最新动态
- 功能总览
- 产品介绍
- 计费说明
- 快速入门
- 用户指南
- 最佳实践
- API参考
-
常见问题
-
技术类问题
- 执行代码检查任务时提示：任务正在执行，稍后重试
- 执行代码检查任务时提示：权限不足，请核对后再试
- 执行代码检查任务时提示：单个任务并发数超过套餐限制，任务无法下发
- 执行代码检查任务时提示：Cppcheck cannot tokenize the code correctly
- 执行代码检查任务时提示：no such file or directory
- 执行代码检查任务时提示：在Maven仓库中找不到依赖
- 执行代码检查任务时提示：调用CodeArts Repo失败，未授权
- 执行代码检查任务时提示：CC.00070400.500
- 单击任务名称时提示权限不足
- C#前端使用WPF组件的项目检查失败
- 任务执行完成后没有数据
- TypeScript任务检查失败，日志显示404
- CC.00130044.400 Execute source plugin failed.
- 执行代码检查任务时报错：CC.00050032.400 没有可检查文件
- 执行代码检查任务时报错：CC.00050050.400 源分支不存在
- 执行代码检查任务时报错：CC.00020413.553 调用CodeArts Repo失败
- 执行代码检查任务时报错：CC.10010226.403 操作权限不足
- 执行代码检查任务时报错：CC.10010263.500 自定义执行机不可用
- 执行代码检查任务时报错：CC.00030117.400 规则集无版本级规则，请检查规则集配置
- 执行代码检查任务时报错：CC.00030308.400 任务执行超过12小时，被系统中止
- 执行代码检查任务时报错：CC.00030009.400 规则集信息不存在
-
执行代码检查任务时报错：CC.00040010.400 代码检查失败，请到检查日志中查看具体错误信息
- 文件格式导致编译失败问题
- unicode解析问题
- findbugs规则在扫描jsp文件时报错
- 代码检查任务，sonarqube引擎的check阶段失败
- sonarqube引擎的check阶段失败日志里elasticSearch启动报错
- sonarqube引擎check阶段失败日志里elasticSearch启动报错
- 检查任务日志显示 Java heap space [ErrorMessage] className is java.util.Arrays, methodName is copyOf, lineNum is ***
- Sonarqube检查css文件日志显示报错无扩展名问题
- 执行启动脚本无权限问题
- SCC初始化锁文件失败
- sonarqube服务启动失败
- sonarqube服务的ES报错磁盘内存不足
- 编译脚本出错，导致检查失败
- 内存不够，导致检查失败
- API类问题
-
技术类问题
- 视频帮助
- 文档下载
- 通用参考
链接复制成功！
获取规则列表接口
功能介绍
根据语言、问题级别等条件查询规则列表。
调用方法
请参见如何调用API。
URI
GET /v2/rules
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
rule_languages |
否 |
String |
规则对应的语言 |
|
rule_severity |
否 |
String |
缺陷等级，0致命；1严重；2一般；3提示。默认全部查询 |
|
offset |
否 |
Integer |
分页索引，偏移量 |
|
limit |
否 |
Integer |
每页显示的数量 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
info |
Array of RuleListItem objects |
规则信息 |
|
total |
Integer |
总数 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
rule_set |
String |
规则集规范分类 |
|
rule_id |
String |
规则id |
|
rule_language |
String |
规则所属语言 |
|
rule_name |
String |
规则名称 |
|
rule_severity |
String |
规则问题级别 |
|
rule_tages |
String |
规则标签 |
|
right_example |
String |
正确示例 |
|
error_example |
String |
错误示例 |
|
revise_opinion |
String |
修改建议 |
|
rule_desc |
String |
规则描述 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
GET https://{endpoint}/v2/rules响应示例
状态码：200
Request succeeded!
{
"info" : [ {
"rule_id" : "2561",
"rule_language" : "Java",
"rule_name" : "\"=+\"不能用\"+=\"代替",
"rule_severity" : "1",
"rule_tages" : "bug",
"rule_desc" : "<p>使用恒等运算符(<code>===</code>)比较不同的类型，其结果总是 <code>false</code> 。</p>",
"right_example" : "<pre>\nvar a = 8;\nvar b = \"8\";\n\nif (a == b) {\n // ...\n}\n</pre>\n<p>or</p>\n<pre>\nvar a = 8;\nvar b = \"8\";\n\nif (a === Number(b)) {\n // ...\n}\n</pre>",
"error_example" : "<pre>\nvar a = 8;\nvar b = \"8\";\n\nif (a === b) { //不规范；比较结果总是false\n // ...\n}\n</pre>",
"revise_opinion" : "无",
"rule_set" : "HuaWeiJava"
}, {
"rule_id" : "8048",
"rule_language" : "Java",
"rule_name" : "\"Arrays.stream\" should be used for primitive arrays",
"rule_severity" : "1",
"rule_tages" : "performance",
"rule_desc" : "<p>使用恒等运算符(<code>===</code>)比较不同的类型，其结果总是 <code>false</code> 。</p>",
"right_example" : "<pre>\nvar a = 8;\nvar b = \"8\";\n\nif (a == b) {\n // ...\n}\n</pre>\n<p>or</p>\n<pre>\nvar a = 8;\nvar b = \"8\";\n\nif (a === Number(b)) {\n // ...\n}\n</pre>",
"error_example" : "<pre>\nvar a = 8;\nvar b = \"8\";\n\nif (a === b) { //不规范；比较结果总是false\n // ...\n}\n</pre>",
"revise_opinion" : "无",
"rule_set" : "HuaWeiJava"
} ],
"total" : 2
}状态码：400
Bad Request
{
"error_code" : "CC.00000000",
"error_msg" : "网络繁忙，请稍后再试"
}状态码：401
Unauthorized
{
"error_code" : "CC.00000003",
"error_msg" : "认证信息过期"
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Request succeeded! |
|
400 |
Bad Request |
|
401 |
Unauthorized |
错误码
请参见错误码。
