文档首页/ 代码检查 CodeArts Check/ API参考/ API/ 任务管理/ 修改任务配置 - ModifyPipelineTaskV2
更新时间：2025-12-30 GMT+08:00
在线调试
CLI示例
查看PDF
分享

修改任务配置 - ModifyPipelineTaskV2

功能介绍

修改代码检查任务部分配置，支持用户从Gitee仓切换到GitCode仓，支持修改任务的版本级检查模式。

调用方法

请参见如何调用API。

授权信息

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

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

codeartscheck:task:update

Write

task *

-

-

-

-

codeartscheck:ProjectId

URI

PUT /v2/pipeline-task/{task_id}

表1 路径参数

参数

是否必选

参数类型

描述

task_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

Content-Type

否

String

参数解释：

设置媒体类型和编码格式。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

application/json;charset=UTF-8
表3 请求Body参数

参数

是否必选

参数类型

描述

repo_url

否

String

参数解释：

代码仓地址。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

endpoint_id

否

String

参数解释：

扩展点ID，来自项目下的代码源扩展点。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

repo_type

否

String

参数解释：

代码仓类型。

约束限制：

取值为Gitee或GitCode。

取值范围：

  • Gitee：Gitee仓。

  • GitCode：GitCode仓。

默认取值：

不涉及。

auth_type

否

String

参数解释：

授权类型。

约束限制：

取值为Gitee或GitCode。

取值范围：

  • Gitee：Gitee仓。

  • GitCode：GitCode仓。

默认取值：

不涉及。

full_check_mode

否

Integer

参数解释：

版本级检查模式。

约束限制：

取值为0或1。

取值范围：

  • 0：版本级检查模式为全量检查。

  • 1：版本级检查模式为Commit检查。

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

result

String

参数解释：

接口响应成功。

取值范围：

Ok

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

状态码：401

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

请求示例

修改任务的RepoUrl和代码源扩展点ID。

PUT https://{endpoint}/v2/pipeline-task/{task_id}

{
  "endpoint_id" : "363540xxxxxxxx5105099944xxxxxxxx",
  "repo_url" : "https://xxx.com/***.git",
  "auth_type" : "GitCode",
  "repo_type" : "GitCode"
}

响应示例

状态码：200

Request succeeded!

{
  "result" : "Ok"
}

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

错误码

请参见错误码。

父主题： 任务管理

相关文档