文档首页/ 代码检查 CodeArts Check/ API参考/ API/ 规则管理/ 查看规则集的规则列表
更新时间：2025-08-19 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查看规则集的规则列表

功能介绍

根据项目ID、规则集ID等条件查询规则列表。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/ruleset/{ruleset_id}/rules

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目的32位uuid，通过查询项目列表接口查询项目列表获取。

约束限制:

不涉及。

取值范围:

32位项目id。

默认取值：

不涉及。

ruleset_id

是

String

参数解释:

规则集ID，通过查询规则集列表接口可获取到规则集ID。

约束限制:

不涉及。

取值范围:

32位规则集ID。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

types

否

String

参数解释:

规则状态。

约束限制:

不涉及。

取值范围:

  • 1，查询全部规则。

  • 2，查询已启用规则。

  • 3，查询未启用。

默认取值:

1

languages

否

String

参数解释:

规则语言。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值：

不涉及。

tags

否

String

参数解释:

规则所属标签。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值：

不涉及。

offset

否

Integer

参数解释:

分页索引，偏移量。

约束限制:

不涉及。

取值范围:

0-999

limit

否

Integer

参数解释:

分页查询，每页显示的数量。

约束限制:

不涉及。

取值范围:

0-200

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

字符串长度不少于1，不超过10万。

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

info

Array of RuleItem objects

参数解释:

规则集的规则列表信息。

取值范围:

不涉及。

total

Integer

参数解释:

总数。

取值范围:

不涉及。
表5 RuleItem

参数

参数类型

描述

rule_id

String

参数解释:

规则id。

取值范围:

32位uuid。

rule_language

String

参数解释:

规则所属语言。

取值范围:

当前支持的语言有：ARKTS,C#,C++,CSS,GO,HTML,JAVA,JAVASCRIPT,KOTLIN,LUA,PHP,PYTHON,RUST,SCALA,SHELL,SQL,TYPESCRIPT。

rule_name

String

参数解释:

规则名称。

取值范围:

不涉及。

rule_severity

String

参数解释:

规则问题级别。

取值范围：

  • 0，致命。

  • 1，严重。

  • 2，一般。

  • 3，提示。

tags

String

参数解释:

规则标签。

取值范围:

huawei,iso5055,cert,cwe,top10,top25,misra,GJB,autosar,PCI DSS等。

checked

String

参数解释:

规则状态。

取值范围:

  • 0，未启用。

  • 1，已启用。

rule_config_list

Array of RuleConfigParam objects

规则配置参数阈值相关信息。
表6 RuleConfigParam

参数

参数类型

描述

id

Integer

参数解释:

规则配置ID。可调用获取规则列表接口获取规则配置ID。

取值范围:

32位uuid。

rule_id

String

参数解释:

工具规则ID，即可配置阈值规则的各种阈值对应的ID，当前无便利手段获取，请联系客服咨询。

取值范围:

32位uuid。

default_value

String

参数解释:

配置参数默认阈值。

取值范围:

不涉及。

option_value

String

参数解释:

配置参数新阈值。

取值范围:

不涉及。

option_key

String

参数解释:

当前规则配置项key。可调用获取规则列表接口获取规则配置ID。

取值范围:

不涉及。

option_name

String

参数解释:

当前规则配置项key。可调用获取规则列表接口获取规则配置ID。

取值范围:

不涉及。

template_id

String

参数解释:

规则集id。可调用查询规则集列表获取规则集id。

取值范围:

32位uuid。

description

String

参数解释:

配置参数的描述。可不填。

取值范围:

不涉及。

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET https://{endpoint}/v2/{project_id}/ruleset/{ruleset_id}/rules

响应示例

状态码：200

Request succeeded!

{
  "info" : [ {
    "rule_language" : "cpp",
    "rule_id" : "1614",
    "checked" : "1",
    "rule_name" : "A buffer must have size of 2 integers if used as parameter of pipe().",
    "rule_severity" : "1",
    "tags" : "cwe",
    "rule_config_list" : [ ]
  }, {
    "rule_language" : "cpp",
    "rule_id" : "1611",
    "checked" : "1",
    "rule_name" : "A buffer must have size of 2 integers if used as parameter of pipe().",
    "rule_severity" : "1",
    "tags" : "cwe",
    "rule_config_list" : [ {
      "id" : 250,
      "rule_id" : 11707,
      "template_id" : "906e7eac47dd4bde9c984f5e6f2a54e8",
      "option_key" : "threshold",
      "option_name" : "新增阈值",
      "option_value" : "10",
      "default_value" : "20",
      "description" : "代码复杂度超过阈值，则会被识别为超大圈复杂度，与圈复杂度统计区别在于统计SWITCH的时候，只统计SWITCH的个数，不统计case,default，必填"
    }, {
      "id" : 251,
      "rule_id" : 11707,
      "template_id" : "906e7eac47dd4bde9c984f5e6f2a54e8",
      "option_key" : "threshold_modify",
      "option_name" : "修改阈值",
      "option_value" : "30",
      "default_value" : "20",
      "description" : "代码复杂度超过阈值，则会被识别为超大圈复杂度。与圈复杂度统计区别在于统计SWITCH的时候，只统计SWITCH的个数，不统计case,default，修改阈值要比新增阈值大，非必填"
    } ]
  } ],
  "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

错误码

请参见错误码。

父主题： 规则管理