文档首页/ 代码检查 CodeArts Check/ API参考/ API/ 规则管理/ 获取规则列表接口
更新时间：2024-03-15 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取规则列表接口

功能介绍

根据语言、问题级别等条件查询规则列表。

调用方法

请参见如何调用API。

URI

GET /v2/rules

表1 Query参数

参数

是否必选

参数类型

描述

rule_languages

否

String

规则对应的语言

rule_severity

否

String

缺陷等级，0致命，1严重，2一般，3提示

offset

否

Integer

分页索引，偏移量

最小值：0

缺省值：0

limit

否

Integer

每页显示的数量

最小值：1

最大值：1000

缺省值：100

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

最小长度：1

最大长度：100000

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

info

Array of RuleListItem objects

规则信息

total

Integer

总数
表4 RuleListItem

参数

参数类型

描述

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

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 401

表6 响应Body参数

参数

参数类型

描述

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

错误码

请参见错误码。

父主题： 规则管理