文档首页/ 代码检查 CodeArts Check/ API参考/ API/ 任务管理/ 查询任务的已选规则集列表v3
更新时间：2024-11-12 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询任务的已选规则集列表v3

功能介绍

查询任务的已选规则集列表v3。

调用方法

请参见如何调用API。

URI

GET /v3/{project_id}/tasks/{task_id}/rulesets

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，每个CodeArts首页下的项目都有1个唯一的项目ID

task_id

是

String

任务ID，即新建检查任务接口的返回值，每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

分页索引，偏移量

limit

否

Integer

每页显示的数量,每页最多显示1000条

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

否

String

设置媒体类型和编码格式

X-Auth-Token

是

String

用户Token

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

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

data

Array of TaskRulesetInfo objects

规则集信息

total

Integer

总数
表5 TaskRulesetInfo

参数

参数类型

描述

template_id

String

规则集id

language

String

规则集语言

template_name

String

规则集名称

type

String

规则集状态optional：可选，selected：已选

status

String

规则集属性0 是默认用户规则集,1 是系统默认规则集

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET https://{endpoint}/v3/{project_id}/tasks/{task_id}/rulesets

响应示例

状态码： 200

Request succeeded!

{
  "total" : 1,
  "data" : [ {
    "template_id" : "111111xxxx3246",
    "language" : "java",
    "type" : "selected",
    "template_name" : "通用检查规则集",
    "status" : "1"
  } ]
}

状态码： 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

错误码

请参见错误码。

父主题： 任务管理

相关文档