查询规则集列表 - ListRulesets

codeartscheck::listRuleSets

List

-

-

-

-

project_id

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

32位项目ID。

默认取值:

不涉及。

category

否

String

参数解释:

规则集类别。

约束限制:

不涉及。

取值范围:

• 0：只查询系统规则集。

• 1：只查询当前用户自定义规则集。

• 2：只查询其他用户自定义规则集。

默认取值:

不涉及。默认查询所有类别的规则集。

offset

否

Integer

参数解释:

分页索引，偏移量。

约束限制:

不涉及。

取值范围:

0-999

默认取值：

0

limit

否

Integer

参数解释:

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

约束限制:

不涉及。

取值范围:

0-100

默认取值：

100

need_selected_status

否

String

参数解释:

是否查询规则集使用状态。

约束限制:

不涉及。

取值范围:

• true：查询规则集使用状态。

• false：不查询规则集使用状态，规则集使用状态全部返回为未使用状态。

默认取值：

true

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

长度为[1~100000]个字符。

默认取值：

不涉及。

info

Array of RulesetItem objects

参数解释:

规则集列表信息。

取值范围:

不涉及。

total

Integer

参数解释:

规则集总数。

取值范围:

≥0

template_id

String

参数解释:

规则集ID。

取值范围:

32位UUID。

language

String

参数解释:

规则集语言。

取值范围:

当前支持的语言有：

• ARKTS

• C#

• CANGJIE

• C++

• CSS

• GO

• HTML

• JAVA

• JAVASCRIPT

• KOTLIN

• LUA

• PHP

• PYTHON

• RUST

• SCALA

• SHELL

• SQL

• TERRAFORM

• TYPESCRIPT

template_name

String

参数解释:

规则集语言。

取值范围:

任意中英文，数字，点，连字符-及下划线_组成的字符串。

creator_id

String

参数解释:

创建者的user_id，值来源于IAM的用户ID。

取值范围:

32位UUID。

creator_name

String

参数解释:

创建人名称，值来源于IAM用户名称。

取值范围:

IAM用户名称。

template_create_time

String

参数解释:

创建时间，时区统一为0时区。

取值范围:

0时区时间。

is_used

String

参数解释:

使用状态。

取值范围:

• 0：空闲中。

• 1：使用中。

rule_ids

String

参数解释:

规则集包含的规则ID，每条规则都有唯一的规则ID。

取值范围:

32位UUID列表，多个UUID以英文逗号分隔。

is_default

String

参数解释:

规则集是否是该语言默认规则集。

取值范围:

• 0：不是。

• 1：是。

is_devcloud_project_default

String

参数解释:

规则集是否是项目下该语言默认规则集。

取值范围:

• 0：不是。

• 1：是。

is_default_template

String

参数解释:

规则集是否是系统规则集。

取值范围:

• 0：不是。

• 1：是。

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

200

Request succeeded!

400

Bad Request

401

Unauthorized