规则查询过滤器

system_tag

否

String

参数解释:

引擎名称。

约束限制:

不涉及。

取值范围:

sonarqube，wordstool，clangtidy，codemars，secbrella，cppcheck，apiengine，eslint，fixbotengine-java，fixbotengine-cxx，oat，pylint，SQLGuardian，cmetrics，codecheckrevive，clippy，detektout，cjlint，flake8，LuaGuardian，thirdpartycheck，FossScan，Infer_Java，testengine。

默认取值：

不涉及。

severitys

否

String

参数解释:

缺陷严重等级。

约束限制:

不涉及。

取值范围:

• 0，致命。

• 1，严重。

• 2，一般。

• 3，提示。

默认取值:

"0,1,2,3"，默认全部查询

languages

否

String

参数解释：

规则语言，多个以英文逗号分隔。

约束限制:

不涉及。

取值范围：

• ARKTS

• C#

• C++

• CSS

• GO

• HTML

• JAVA

• JAVASCRIPT

• KOTLIN

• LUA

• PHP

• PYTHON

• RUST

• SCALA

• SHELL

• SQL

• TYPESCRIPT

默认取值：

不涉及。

search

否

String

参数解释:

关键字搜索。

约束限制:

不涉及。

取值范围:

不涉及

默认取值：

不涉及。

set_id

否

String

参数解释:

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

约束限制:

不涉及。

取值范围:

32位规则集ID。

默认取值：

不涉及。

status

否

String

参数解释:

规则集规则是否为启用状态。

约束限制:

不涉及。

取值范围:

• enable，启用状态。

• disable，非启用状态。

默认取值：

enable。

inherit

否

String

参数解释:

继承类型。

约束限制:

不涉及。

取值范围:

• true，继承的规则。

• false，非继承的规则。

• rewrite，改写的规则。

默认取值：

默认为null，查询所有继承类型规则。

onlines

否

String

参数解释:

上线状态。

约束限制:

不涉及。

取值范围:

• 0，下线状态。

• 1，上线状态。

默认取值：

1

show_tool_version

否

String

参数解释:

展示版本。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值：

不涉及。

tool_version

否

String

参数解释:

工具版本。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值：

不涉及。

cwe_search

否

String

参数解释:

cwe搜索。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值：

不涉及。

compile

否

String

参数解释:

是否为编译类规则。

约束限制:

不涉及。

取值范围:

• compile，编译类。

• noCompile，非编译类。

默认取值：

不涉及。

security

否

String

参数解释:

安全与质量分类。

约束限制:

不涉及。

取值范围:

• security，安全类。

• security_enhance，代码检查安全增强。

• quality，质量类。

默认取值：

不涉及。

industry_standards

否

String

参数解释:

业界标准。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值：

不涉及。

source_type

否

String

参数解释:

规则创建类型。

约束限制:

不涉及。

取值范围:

• 0，自定义规则。

• 1，系统规则。

默认取值：

不涉及。

project_id

否

String

参数解释:

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

约束限制:

不涉及。

取值范围:

32位项目id。

默认取值：

不涉及。

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

operator

是

String

参数解释：

操作人，填写账号用户名。

约束限制：

不涉及

取值范围：

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

默认取值：

不涉及。

httpStatus

String

参数解释：

HTTP响应状态，接口响应成功时为"OK"，接口响应失败时为其他HTTP状态码。如INTERNAL_SERVER_ERROR为接口内部异常，BAD_REQUEST是参数校验异常。

取值范围：

• OK，接口响应成功。

• ACCEPTED，接口响应成功。

• INTERNAL_SERVER_ERROR，接口内部异常。

• BAD_REQUEST，参数校验异常。

result

CriterionFilterInfo object

参数解释：

规则过滤器。

取值范围：

不涉及。

status

String

参数解释：

接口响应状态。

取值范围：

• success，接口响应成功。

• error，接口响应失败。

languageInfoList

Array of FilterUnit objects

参数解释：

语言过滤器列表。

取值范围：

不涉及。

severityInfoList

Array of FilterUnit objects

参数解释：

告警等级过滤器列表。

取值范围：

不涉及。

filterKey

String

参数解释：

过滤器指标名。

取值范围：

• language，语言。

• severity，告警等级。

• status，规则启用状态。

• system_tag，检查引擎。

• compile，是否为编译规则。

• security，安全与质量。

• industryStandards，业界标准。

• onlines，上下线状态。

• sourceType，是否系统规则。

• inherit，继承状态。

filterValue

Integer

参数解释：

过滤器指标对应的数值。

取值范围：

不涉及。

error_code

String

错误码

error_msg

String

错误描述

error_code

String

错误码

error_msg

String

错误描述

200

query filters and counts by filter

400

Bad Request

401

Unauthorized