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

查询任务的已选规则集列表V2 - ListTaskRuleset

功能介绍

根据项目ID和任务ID查询任务已选的规则集和可启用的规则集，返回规则集名称、ID、语言等信息，该接口不支持分页查询。

调用方法

请参见如何调用API。

授权信息

账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

codeartscheck:task:get

Read

task *

-

-

-

-

codeartscheck:ProjectId

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

task_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

needExtendInfo

否

String

参数解释：

是否需要扩展信息：未启用语言对应的可选规则集、规则集的名称和使用状态。

约束限制：

不涉及。

取值范围：

  • true：需要。

  • false：不需要。

默认取值：

true

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of TaskRulesetInfo objects

参数解释:

规则集信息的数组。

取值范围:

不涉及。

表5 TaskRulesetInfo

参数

参数类型

描述

template_id

String

参数解释：

规则集ID。

取值范围:

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

language

String

参数解释：

规则集语言。

取值范围:

自定义语言或者系统内置语言，当前支持的系统内置语言有：

  • ARKTS

  • C#

  • CANGJIE

  • C++

  • CSS

  • GO

  • HTML

  • JAVA

  • JAVASCRIPT

  • KOTLIN

  • LUA

  • PHP

  • PYTHON

  • RUST

  • SCALA

  • SHELL

  • SQL

  • TERRAFORM

  • TYPESCRIPT

template_name

String

参数解释：

规则集名称。

取值范围:

不涉及。

type

String

参数解释：

规则集选取状态。

取值范围:

  • selected：已选。

  • optional：可选，指未开启的语言在当前项目下的默认规则集。

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}/v2/{project_id}/tasks/{task_id}/rulesets

响应示例

状态码：200

Request succeeded!

[ {
  "template_id" : "396e1c2511744f6fa199d33b26038edd",
  "language" : "Java",
  "template_name" : "Java_cmetrics",
  "type" : "selected",
  "status" : "0"
}, {
  "template_id" : "4e988c481b4c46d0a3297fbe343a662d",
  "language" : "html",
  "template_name" : "通用检查规则集",
  "type" : "optional",
  "status" : "1"
} ]

状态码：400

Bad Request

{
  "error_code" : "CC.xxxxxxxx.400",
  "error_msg" : "请求参数校验失败,请检查请求参数是否正确"
}

状态码：401

Unauthorized

{
  "error_code" : "CC.00000003",
  "error_msg" : "认证信息过期"
}

状态码

状态码

描述

200

Request succeeded!

400

Bad Request

401

Unauthorized

错误码

请参见错误码。

父主题： 任务管理

相关文档