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

查看规则集的规则列表

功能介绍

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

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，每个CodeArts首页下的项目都有1个唯一的项目ID

ruleset_id

是

String

规则集ID
表2 Query参数

参数

是否必选

参数类型

描述

types

是

String

规则状态

'1查询全部，2已启动，3未启用'

languages

否

String

规则语言

tags

否

String

规则所属标签

offset

否

Integer

分页索引，偏移量

limit

否

Integer

每页显示的数量

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token

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

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

info

Array of RuleItem objects

规则集的规则列表信息

total

Integer

总数
表5 RuleItem

参数

参数类型

描述

rule_id

String

规则id

rule_language

String

规则所属语言

rule_name

String

规则名称

rule_severity

String

规则问题级别

tags

String

规则标签

checked

String

规则状态0：未启用，1：已启用

rule_config_list

Array of RuleConfig objects

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

参数

参数类型

描述

id

Integer

规则配置ID

rule_id

String

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

default_value

String

默认值

option_value

String

当前

option_key

String

当前规则配置项key

option_name

String

当前规则配置项名称

template_id

String

规则集id

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

错误码

请参见错误码。

父主题： 规则管理