查询任务的已选规则集列表v3
功能介绍
查询任务的已选规则集列表v3。
调用方法
请参见如何调用API。
URI
GET /v3/{project_id}/tasks/{task_id}/rulesets
| 
         参数  | 
       
         是否必选  | 
       
         参数类型  | 
       
         描述  | 
      
|---|---|---|---|
| 
         project_id  | 
       
         是  | 
       
         String  | 
       
         参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口查询项目列表获取。 约束限制: 不涉及。 取值范围: 32位项目ID。 默认取值: 不涉及。  | 
      
| 
         task_id  | 
       
         是  | 
       
         String  | 
       
         参数解释: 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。  | 
      
| 
         参数  | 
       
         是否必选  | 
       
         参数类型  | 
       
         描述  | 
      
|---|---|---|---|
| 
         needExtendInfo  | 
       
         否  | 
       
         String  | 
       
         参数解释: 是否需要扩展信息:未启用语言对应的可选规则集、规则集的名称和使用状态。 约束限制: 不涉及。 取值范围: 
  | 
      
| 
         offset  | 
       
         否  | 
       
         Integer  | 
       
         参数解释: 页码,类似page_num的作用。 约束限制: 不涉及。 取值范围: 0-999999  | 
      
| 
         limit  | 
       
         否  | 
       
         Integer  | 
       
         参数解释: 每页数量,类似page_size的作用。 约束限制: 不涉及。 取值范围: 1-1000  | 
      
请求参数
| 
         参数  | 
       
         是否必选  | 
       
         参数类型  | 
       
         描述  | 
      
|---|---|---|---|
| 
         X-Auth-Token  | 
       
         是  | 
       
         String  | 
       
         参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。  | 
      
响应参数
状态码:200
| 
         参数  | 
       
         参数类型  | 
       
         描述  | 
      
|---|---|---|
| 
         data  | 
       
         Array of TaskRulesetInfo objects  | 
       
         参数解释: 规则集信息。 取值范围: 不涉及。  | 
      
| 
         total  | 
       
         Integer  | 
       
         参数解释: 总数。 取值范围: 不涉及。  | 
      
| 
         参数  | 
       
         参数类型  | 
       
         描述  | 
      
|---|---|---|
| 
         template_id  | 
       
         String  | 
       
         参数解释: 规则集ID。 取值范围: 32位规则集ID。  | 
      
| 
         language  | 
       
         String  | 
       
         参数解释: 规则集语言。 取值范围: 不涉及。  | 
      
| 
         template_name  | 
       
         String  | 
       
         参数解释: 规则集名称。 取值范围: 不涉及。  | 
      
| 
         type  | 
       
         String  | 
       
         参数解释: 规则集选取状态。 取值范围: 
  | 
      
| 
         status  | 
       
         String  | 
       
         参数解释: 规则集属性。 取值范围: 
  | 
      
状态码:400
| 
         参数  | 
       
         参数类型  | 
       
         描述  | 
      
|---|---|---|
| 
         error_code  | 
       
         String  | 
       
         错误码  | 
      
| 
         error_msg  | 
       
         String  | 
       
         错误描述  | 
      
状态码:401
| 
         参数  | 
       
         参数类型  | 
       
         描述  | 
      
|---|---|---|
| 
         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  | 
      
错误码
请参见错误码。