查询规则列表-V2 - ListCriterion

codeartscheck::listRules

List

-

-

-

-

page_size

否

Integer

参数解释:

分页大小。

约束限制:

不涉及。

取值范围:

1-200

默认取值：

10

page

否

Integer

参数解释:

页码。

约束限制:

不涉及。

取值范围:

1-999

默认取值：

1

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#

• CANGJIE

• C++

• CSS

• GO

• HTML

• JAVA

• JAVASCRIPT

• KOTLIN

• LUA

• PHP

• PYTHON

• RUST

• SCALA

• SHELL

• SQL

• TERRAFORM

• TYPESCRIPT

默认取值：

不涉及。

search

否

String

参数解释:

关键字搜索。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值：

不涉及。

set_id

否

String

参数解释:

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

约束限制:

不涉及。

取值范围:

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

默认取值：

不涉及。

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~100000]个字符。

默认取值：

不涉及。

operator

否

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

httpStatus

String

参数解释：

HTTP响应状态。

取值范围：

• OK：请求已成功处理，服务器返回了请求的资源或操作结果。

• ACCEPTED：请求已被服务器接受，但处理尚未完成（通常用于异步操作）。

• INTERNAL_SERVER_ERROR：接口内部异常。

• BAD_REQUEST：参数校验异常。

result

CriterionQueryInfo object

参数解释：

规则列表。

取值范围：

不涉及。

status

String

参数解释：

接口响应状态。

取值范围：

• success：接口响应成功。

• error：接口响应失败。

criterionList

Array of CriterionInfoBody objects

参数解释：

规则列表。

取值范围：

不涉及。

setLanguage

String

参数解释：

规则集语言。

取值范围：

不涉及。

setName

String

参数解释：

规则集名称。

取值范围：

不涉及。

total

Integer

参数解释：

规则总数。

取值范围：

≥0

id

String

参数解释：

能力规则ID。

取值范围：

不涉及。

name

String

参数解释：

能力规则的中文名称。

取值范围：

不涉及。

nameCn

String

参数解释：

能力规则的英文名称。

取值范围：

不涉及。

isSupportVersion

String

参数解释：

规则集内，该规则设置是否支持版本级检查。

取值范围：

• enable：支持。

• disable：不支持。

isSupportPersonal

String

参数解释：

规则集内，该规则设置是否支持门禁级检查。

取值范围：

• enable：支持。

• disable：不支持。

isSupportIDE

String

参数解释：

规则集内，该规则设置是否支持IDE级检查。

取值范围：

• enable：支持。

• disable：不支持。

supportVersion

String

参数解释：

规则是否支持版本级检查。

取值范围：

• 1：支持。

• 0：不支持。

supportPersonal

String

参数解释：

规则是否支持IDE级检查。

取值范围：

• 1：支持。

• 0：不支持。

supportIDE

String

参数解释：

规则是否支持IDE级检查。

取值范围：

• 1：支持。

• 0：不支持。

comments

String

参数解释：

描述信息。

取值范围：

不涉及。

goodExample

String

参数解释：

正确示例。

取值范围：

不涉及。

badExample

String

参数解释：

错误示例。

取值范围：

不涉及。

recommend

String

参数解释：

修复建议。

取值范围：

不涉及。

severity

String

参数解释：

告警等级。

取值范围：

• 0：致命。

• 1：严重。

• 2：一般。

• 3：提示。

language

String

参数解释：

规则语言。

取值范围：

• ARKTS

• C#

• CANGJIE

• C++

• CSS

• GO

• HTML

• JAVA

• JAVASCRIPT

• KOTLIN

• LUA

• PHP

• PYTHON

• RUST

• SCALA

• SHELL

• SQL

• TERRAFORM

• TYPESCRIPT

systemTag

String

参数解释:

引擎名称。

取值范围:

codemars，secbrella等。

criterionSetId

String

参数解释:

规则集ID。

取值范围:

32位UUID。查询规则集内规则列表时，该字段有值。查询规则列表时，该字段为空。

options

Array of CriterionOption objects

参数解释：

规则关联的配置参数列表。

取值范围：

不涉及。

criterionType

String

参数解释：

业务类型分类。

取值范围:

• common：通用。

• common_standard_recommend：通用建议。

• common_standard_rule：通用规则。

• security：安全。

• security_standard_recommend：安全建议。

• security_standard_rule：安全规则。

userTag

String

参数解释：

用户标签。

取值范围:

不涉及。

cwe

String

参数解释：

cwe编号。

取值范围:

不涉及。

delayStartTime

String

参数解释：

延迟告警开始时间，使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。例如：2020-09-25T12:05:00Z。

取值范围:

不涉及。

delayEndTime

String

参数解释：

延迟告警结束时间，使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。

取值范围:

不涉及。

creator

String

参数解释：

创建者。

取值范围:

自定义规则的创建者为用户名。

sourceType

String

参数解释：

规则类型。

取值范围:

• 0：自定义规则。

• 1：系统规则。

toolVersion

String

参数解释：

规则版本。

取值范围:

不涉及。

uniqueId

String

参数解释：

能力规则唯一ID。

取值范围:

32位UUID。

domainId

String

参数解释：

租户ID。

取值范围:

• system：系统规则。

• 32位UUID：创建自定义规则的租户ID。

creatorId

String

参数解释：

租户ID。

取值范围:

• system：系统规则。

• 32位UUID：创建自定义规则的用户ID。

ruleId

String

参数解释：

工具规则ID。

取值范围：

32位UUID。

ruleName

String

参数解释：

工具规则名。

取值范围：

不涉及。

criterionId

String

参数解释：

能力规则ID。

取值范围：

32位UUID。

criterionSetId

String

参数解释：

规则集ID。

取值范围：

32位UUID。

optionKey

String

参数解释：

配置参数项的key。

取值范围：

不涉及。

name

String

参数解释：

option名称。

取值范围：

不涉及。

optionValue

String

参数解释：

配置参数的值，由用户配置。若为空，则使用默认值。

取值范围：

不涉及。

description

String

参数解释：

配置参数的解释信息。

取值范围：

不涉及。

defaultValue

String

参数解释：

默认值。

取值范围：

不涉及。

valueType

String

参数解释：

参数值类型。

取值范围：

• BOOLEAN：布尔类型。

• FLOAT：浮点数类型。

• INTEGER：整数类型。

• STRING：字符串类型。

• 字段为空：默认为STRING。

valueRange

String

参数解释：

配置参数取值范围。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

200

query criterions

400

Bad Request

401

Unauthorized