查询任务规则集的检查参数v3
功能介绍
查询任务规则集的检查参数v3
调用方法
请参见如何调用API。
URI
GET /v3/{project_id}/tasks/{task_id}/ruleset/{ruleset_id}/check-parameters
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，每个CodeArts首页下的项目都有1个唯一的项目ID |
|
task_id |
是 |
String |
任务ID，即新建检查任务接口的返回值，每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID |
|
ruleset_id |
是 |
String |
规则集ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
language |
是 |
String |
规则集语言 |
|
offset |
否 |
Integer |
分页索引，偏移量，非必填 |
|
limit |
否 |
Integer |
每页显示的数量，非必填 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Content-Type |
否 |
String |
设置媒体类型和编码格式 |
|
X-Auth-Token |
是 |
String |
用户Token通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
Array of TaskCheckParamters objects |
历史记录数据 |
|
total |
Integer |
总数 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
check_id |
Integer |
检查工具ID |
|
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 |
检查参数值 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
GET https://{endpoint}/v3/{project_id}/tasks/{task_id}/ruleset/{ruleset_id}/check-parameters
响应示例
状态码： 200
Request succeeded!
{
"total" : 1,
"data" : [ {
"check_id" : 0,
"name" : "compile_tool",
"check_configs" : [ {
"value" : "",
"name" : "编译命令",
"cfg_key" : "",
"default_value" : "",
"option_value" : "",
"is_required" : 0,
"description" : "编译命令",
"type" : 0,
"status" : "on"
} ]
} ]
}
状态码： 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 |
错误码
请参见错误码。
