文档首页/ 代码检查 CodeArts Check/ API参考/ API/ 任务管理/ 新建检查任务V3 - CreateTaskV3
更新时间：2025-11-28 GMT+08:00
在线调试
CLI示例
查看PDF
分享

新建检查任务V3 - CreateTaskV3

功能介绍

新建一个代码检查任务，新建任务时可以指定项目ID、项目名、代码仓地址、分支、任务名、规则集等信息，新建的代码检查任务可以使用指定的规则集扫描代码仓。

调用方法

请参见如何调用API。

授权信息

当前API调用无需身份策略权限。

URI

POST /v3/task

请求参数

表1 请求Body参数

参数

是否必选

参数类型

描述

branch

是

String

参数解释：

仓库分支。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

config_template

是

CreateTaskV3ConfigTemplate object

参数解释：

任务的配置模板参数，存放任务相关的一些配置。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

name

是

String

参数解释：

任务名。

约束限制：

任意中英文、数字、点.、连字符-及下划线_，且长度为1-128。

取值范围：

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

默认取值：

不涉及。

project_id

否

String

参数解释：

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

约束限制：

不涉及。

取值范围：

32位项目ID。

默认取值：

不涉及。

project_name

否

String

参数解释：

项目名称，通过查询项目列表接口查询项目列表获取。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

repo_url

是

String

参数解释：

代码仓地址。

约束限制：

不涉及。

取值范围：

repo仓传以git开头的地址；

非repo仓传以http开头的地址。

默认取值：

不涉及。
表2 CreateTaskV3ConfigTemplate

参数

是否必选

参数类型

描述

repo_type

是

String

参数解释：

代码仓类型。

约束限制：

不涉及。

取值范围：

  • DevCloud：CodeArtsRepo仓。

  • Gitee：Gitee仓。

  • GitHub：GitHub仓。

  • GitPub：通用Git仓。

  • gitcode：GitCode仓。

  • gitlab：GitLab仓。

  • self_gitlab：自建GitLab仓。

  • tfs_git：TFS仓。

  • bitbucket：Bitbucket仓。

默认取值：

不涉及。

branch

是

String

参数解释：

分支名。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

rule_sets

是

Array of ConfigTemplateRuleSet objects

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

32位项目ID。

默认取值：

不涉及。

project_name

是

String

参数解释：

项目名称，通过查询项目列表接口查询项目列表获取。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

authId

否

String

参数解释：

用户预先创建的项目下的代码源扩展点ID，保存了代码仓信息。

约束限制：

使用CodeArtsRepo仓可不填，使用其他类型仓库必填。

取值范围：

不涉及。

默认取值：

不涉及。

authType

否

String

参数解释：

授权类型。

约束限制：

使用CodeArtsRepo仓可不填，使用其他类型仓库必填。

取值范围：

  • DevCloud：CodeArtsRepo仓。

  • Gitee：Gitee仓。

  • GitHub：GitHub仓。

  • GitPub：通用Git仓。

  • gitcode：GitCode仓。

  • gitlab：GitLab仓。

  • self_gitlab：自建GitLab仓。

  • tfs_git：TFS仓。

  • bitbucket：Bitbucket仓。

默认取值：

不涉及。
表3 ConfigTemplateRuleSet

参数

是否必选

参数类型

描述

language

否

String

参数解释：

语言类型。

约束限制：

不涉及。

取值范围：

C#，CSS，C++，PYTHON，CANGJIE，C，SCALA，GO，KOTLIN，JAVASCRIPT，SQL，ARKTS，RUST，JAVA，SHELL，FORTRAN，PHP，LUA，JSON，HTML，TYPESCRIPT，以及自定义的语言。

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

result

CreateTaskV3Result object

参数解释：

创建代码检查任务的结果。

httpStatus

String

参数解释：

HTTP响应状态。

取值范围：

  • OK，接口响应成功。

  • ACCEPTED，接口响应成功。

  • INTERNAL_SERVER_ERROR，接口内部异常。

  • BAD_REQUEST，参数校验异常。

status

String

参数解释：

接口响应状态。

取值范围：

  • success，接口响应成功。

  • error，接口响应失败。
表5 CreateTaskV3Result

参数

参数类型

描述

id

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

在项目id为8c7c74775f4f496596e4a39d34b209c3和项目名为projectName的项目下新建任务名为CppWebHookTest和分支为master和检查语言为C++的CodeArtsRepo仓库类型的代码检查任务。

POST https://{endpoint}/v3/task

{
  "repo_url" : "git@codehub.devcloud.example.com:8c7c74775f4f496596e4a39d34b209c3/CppWebHookTest.git",
  "branch" : "master",
  "name" : "CppWebHookTest",
  "config_template" : {
    "branch" : "master",
    "repo_type" : "DevCloud",
    "rule_sets" : [ {
      "language" : "C++"
    } ],
    "project_id" : "8c7c74775f4f496596e4a39d34b209c3",
    "project_name" : "projectName"
  },
  "project_id" : "8c7c74775f4f496596e4a39d34b209c3",
  "project_name" : "projectName"
}

响应示例

状态码：200

Request succeeded!

{
  "httpStatus" : "OK",
  "result" : {
    "checkParamList" : [ ],
    "criterionSets" : [ ],
    "customParams" : [ ],
    "id" : "8df8d58f832a408f88e4aebea0ff6fc5",
    "modelSets" : [ ],
    "reviewData" : [ ],
    "ruleSets" : [ ],
    "taskIds" : [ ],
    "versionUpdateDelayDays" : [ ]
  },
  "status" : "success"
}

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

错误码

请参见错误码。

父主题： 任务管理

相关文档