更新时间:2025-08-25 GMT+08:00
分享

修改任务配置

功能介绍

修改任务配置,支持用户从Gitee仓切换到GitCode仓

调用方法

请参见如何调用API

URI

PUT /v2/pipeline-task/{task_id}

表1 路径参数

参数

是否必选

参数类型

描述

task_id

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

Content-Type

String

设置媒体类型和编码格式

表3 请求Body参数

参数

是否必选

参数类型

描述

repo_url

String

代码仓地址

endpoint_id

String

项目下的代码源扩展点ID

repo_type

String

代码仓类型,字符串格式,支持Gitee、GitCode

auth_type

String

授权类型,字符串格式,支持Gitee、GitCode

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

result

String

参数解释:

接口响应成功。

约束限制:

不涉及。

状态码: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.00000000",
  "error_msg" : "网络繁忙,请稍后再试"
}

状态码:401

Unauthorized

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

状态码

状态码

描述

200

Request succeeded!

400

Bad Request

401

Unauthorized

错误码

请参见错误码

相关文档