查询任务规则集的检查参数v3 - CheckRulesetParameters

codeartscheck:task:get

Read

task *

-

-

-

-

codeartscheck:ProjectId

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

32位项目ID。

默认取值：

不涉及。

task_id

是

String

参数解释：

任务ID，即新建检查任务接口的返回值，每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即查询任务列表接口响应中的id字段。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

ruleset_id

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

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

默认取值：

不涉及。

language

是

String

参数解释：

规则集语言。

约束限制:

不涉及。

取值范围：

• ARKTS

• C#

• CANGJIE

• C++

• CSS

• GO

• HTML

• JAVA

• JAVASCRIPT

• KOTLIN

• LUA

• PHP

• PYTHON

• RUST

• SCALA

• SHELL

• SQL

• TERRAFORM

• TYPESCRIPT

默认取值：

不涉及。

offset

否

Integer

参数解释：

偏移量。

约束限制：

不涉及。

取值范围：

≥0

默认取值：

0

limit

否

Integer

参数解释：

每页显示的数量。

约束限制：

不涉及。

取值范围：

1-1000

默认取值：

10

X-Auth-Token

是

String

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

data

Array of TaskCheckParameters objects

参数解释：

历史记录数据。

total

Integer

参数解释：

总数。

取值范围:

≥0

check_id

Integer

参数解释：

检查工具ID。

取值范围:

≥0

name

String

参数解释：

编译参数名称。

取值范围:

不涉及。

checker_configs

Array of CheckConfigInfo objects

参数解释：

检查参数配置信息。

name

String

参数解释：

检查参数名称。

取值范围:

不涉及。

cfg_key

String

参数解释：

检查参数对应的Key值。

取值范围:

不涉及。

default_value

String

参数解释：

检查参数默认值。

取值范围:

不涉及。

option_value

String

参数解释：

检查参数可选项。

取值范围:

不涉及。

is_required

Integer

参数解释：

是否必填参数。

取值范围:

• 0：非必填。

• 1：必填。

description

String

参数解释：

检查参数说明。

取值范围:

不涉及。

type

Integer

参数解释：

参数类型。

取值范围:

• 0：文本。

• 2：有可选项。

status

String

参数解释：

参数状态。

取值范围:

• on：启用。

• off：未启用。

value

String

参数解释：

检查参数值。

取值范围:

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

200

Request succeeded!

400

Bad Request

401

Unauthorized