修改任务配置 - ModifyPipelineTaskV2

codeartscheck:task:update

Write

task *

-

-

-

-

codeartscheck:ProjectId

task_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

Content-Type

否

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

application/json;charset=UTF-8

zone

否

String

参数解释：

区域。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

from

否

String

参数解释：

任务来源。

约束限制：

不涉及。

取值范围：

• customer：来自页面点击。

• Scheduled：来自定时任务。

• CodeCheckEdge：来自Edge服务。

• CodeArtsPipeline：来自流水线。

• DevCloudWebhook：来自CodeArtsRepo的Webhook(代码托管网络钩子)。

• GitCodeActionPipeline：来自流水线的GitCodeAction插件。

默认取值：

不涉及。

isAutoCreateAuth

否

Boolean

参数解释：

是否自动创建授权。

约束限制：

不涉及。

取值范围：

• true：自动创建授权。

• false：不自动创建授权。

默认取值：

不涉及。

taskName

否

String

参数解释：

任务名称。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

projectId

否

String

参数解释：

项目ID，项目的32位UUID，项目唯一标识。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

owner

否

String

参数解释：

任务所有者。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

branchName

否

String

参数解释：

分支名称。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

ruleSets

否

Array of RuleSetV2 objects

参数解释：

规则集列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

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检查。

默认取值：

不涉及。

ruleset_id

否

String

参数解释：

规则集ID。

约束限制:

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

取值范围：

不涉及。

默认取值：

不涉及。

language

是

String

参数解释：

检查语言，支持的语言请关注服务更新特性文档。

约束限制:

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

httpStatus

String

参数解释：

HTTP响应状态。

取值范围：

• OK：请求已成功处理，服务器返回了请求的资源或操作结果。

• ACCEPTED：请求已被服务器接受，但处理尚未完成（通常用于异步操作）。

• INTERNAL_SERVER_ERROR：接口内部异常。

• BAD_REQUEST：参数校验异常。

result

TaskBasicInfoV3 object

参数解释：

任务信息。

status

String

参数解释：

接口响应状态。

取值范围：

• success：接口响应成功。

• error：接口响应失败。

avastarType

String

参数解释：

头像颜色。

取值范围：

• pure-blue：蓝色。

• pure-purple：紫色。

• pure-tomato：红色。

• pure-green：绿色。

• pure-orange：橙色。

• pure-pink：粉色。

branchName

String

参数解释：

分支名称。

取值范围：

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

canChangeIgnoreMode

Boolean

参数解释：

是否可以更新忽略文件模式。

取值范围：

• true：能更新忽略文件模式。

• false：不能更新忽略文件模式。

canDelete

Boolean

参数解释：

是否有删除任务的权限。

取值范围：

• true：有删除的权限。

• false：没有删除的权限。

canEdit

Boolean

参数解释：

是否有编辑的权限。

取值范围：

• true：有编辑的权限。

• false：没有编辑的权限。

canEditTemplateSwitch

Boolean

参数解释：

是否有切换任务模板的权限。

取值范围：

• true：有切换任务模板的权限。

• false：没有切换任务模板的权限。

canExecute

Boolean

参数解释：

是否有执行的权限。

取值范围：

• true：有执行的权限。

• false：没有执行的权限。

canRead

Boolean

参数解释：

是否有读的权限。

取值范围：

• true：有读的权限。

• false：没有读的权限。

checkParamList

Array of CustomParameter objects

参数解释：

自定义参数列表。

checkParamMap

checkParamMap object

参数解释：

自定义参数列表checkParamList的map格式，比如含有自定义参数key为param1，值为value1，则checkParamMap含有字段param1，值为value1。

configTemplateId

String

参数解释：

任务的配置模板的ID。

取值范围：

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

createTime

String

参数解释：

任务的创建时间，使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ，例如"2025-11-28T06:55:41Z"。

取值范围：

不涉及。

criterionSets

Array of ConfigTemplateRuleSetInfo objects

参数解释：

规则集列表，该字段一般返回空数组[]。

customParams

Array of CustomParameter objects

参数解释：

自定义参数列表，该字段一般返回空数组[]。

defaultBranchName

String

参数解释：

默认分支的分支名。

取值范围：

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

fileEncoding

String

参数解释：

文件编码。

取值范围：

• UTF-8：UTF-8格式。

• GBK：GBK格式。

hwCloudRegion

String

参数解释：

华为云地域。

取值范围：

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

id

String

参数解释：

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

取值范围：

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

includePaths

String

参数解释：

检查目录。

不配置检查目录时，检查代码仓中所有目录下的代码文件；

配置检查目录时，只检查配置目录中的代码文件。

取值范围：

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

isSetMrWebhook

Boolean

参数解释：

是否打开合并请求时触发。

取值范围：

• true：打开。

• false：关闭。

isSetPushWebhook

Boolean

参数解释：

是否打开代码提交时触发。

取值范围：

• true：打开。

• false：关闭。

isSetWebhook

Boolean

参数解释：

是否打开合并请求时触发。

取值范围：

• true：打开。

• false：关闭。

isTemplateTask

Boolean

参数解释：

是否是任务模板。

取值范围：

• true：是任务模板。

• false：不是任务模板。

jobId

String

参数解释：

执行ID，来自代码检查执行任务接口的返回值，每次执行代码检查任务都有唯一的执行ID。

取值范围：

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

jobTimeout

String

参数解释:

超时时间，以分钟为单位，格式固定为"xxx min"，其中xxx为整数，0 ＜ xxx ≤ 1200。

取值范围：

不涉及。

lastFinishedFullJobId

String

参数解释：

最后一次检查完成的任务的执行ID。

取值范围：

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

lastJob

JobBasicInfoV3 object

参数解释：

执行记录信息。

lastReviser

String

参数解释：

任务的最后修改人。

取值范围：

不涉及。

lastUpdateTime

String

参数解释：

任务的上一次更新时间，使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ，例如"2025-11-28T06:55:41Z"。

取值范围：

不涉及。

modelSets

Array of strings

参数解释：

模型集列表，该字段一般返回空数组[]。

mrCheckBranchStrategy

Integer

参数解释：

mr检查分支门禁策略。

取值范围：

• 0：白名单。

name

String

参数解释：

代码检查任务名。

取值范围：

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

notificationConfig

String

参数解释：

消息通知是否使用项目通知设置的配置项，格式为x,x,x,x,x,x，其中x的取值为0或者1。

x为0时代表使用任务的通知设置，x为1时代表使用项目通知设置。

从左到右依次为站内消息通知、邮件通知、企业微信、钉钉、飞书、通用webhook的消息通知配置。

取值范围：

格式为x,x,x,x,x,x，其中x的取值为0或者1。

owner

String

参数解释：

代码检查任务所有者。

取值范围：

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

ownerId

String

参数解释：

代码检查任务所有者的用户ID。

取值范围：

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

projectId

String

参数解释：

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

取值范围：

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

projectName

String

参数解释：

项目名。

取值范围：

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

region

String

参数解释：

地域，此字段固定为"suzhou"。

取值范围：

suzhou。

repoId

String

参数解释：

代码仓地址对应的CodeartsRepo仓的RepoId。

取值范围：

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

repoUrl

String

参数解释：

代码仓地址。

取值范围：

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

reviewData

Array of strings

参数解释：

门禁配置，该字段一般返回空数组[]。

ruleSets

Array of strings

参数解释：

规则集配置，该字段一般返回空数组[]。

source

String

参数解释：

任务来源，一般为"customer"。

取值范围：

customer。

taskGroupId

String

参数解释：

任务分组的ID。

取值范围：

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

taskIds

Array of strings

参数解释：

任务ID列表，该字段一般返回空数组[]。

tenantId

String

参数解释：

任务所属的租户的租户ID，租户ID的值来源于IAM的租户ID。

取值范围：

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

useCache

Boolean

参数解释：

查询任务信息是否使用缓存。

取值范围：

• true：使用缓存。

• false：不使用缓存。

useWorkspaceNotificationConfig

Integer

参数解释：

消息通知是否使用项目通知设置的配置项，来自notificationConfig的对应的二进制的取反转化成十进制。

例如，notificationConfig配置为1,1,0,1,0,0，则二进制为110100，取反为001011，转化为10进制时该值为11，最终useWorkspaceNotificationConfig的值为11。

取值范围：

0-31

versionUpdateDelayDays

Array of strings

参数解释：

版本升级缓冲期，该字段一般返回空数组[]。

webhookCheckMode

Integer

参数解释：

webhook检查模式，一般为0，代表禁止来自其它代码仓的MR。

取值范围：

0

zone

String

参数解释：

区域，一般为green。

取值范围：

green。

param1

String

参数解释：

字段的name为自定义参数的Key，字段的值为自定义参数的Value。

取值范围：

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

param2

String

参数解释：

字段的name为自定义参数的Key，字段的值为自定义参数的Value。

取值范围：

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

isPrivate

Boolean

参数解释：

是否是私密参数。

取值范围：

• true：私密参数。

• false：非私密参数。

key

String

参数解释：

自定义参数的key。

取值范围：

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

value

String

参数解释：

自定义参数的Value。

取值范围：

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

executor

String

参数解释：

执行人用户名。

取值范围：

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

finishTime

String

参数解释：

执行记录的检查完成时间，使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ，例如"2025-11-28T06:55:41Z"。

取值范围：

不涉及。

id

String

参数解释：

执行ID，来自代码检查执行任务接口的返回值，每次执行代码检查任务都有唯一的执行ID。

取值范围：

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

jobResult

JobResultInfo object

参数解释：

执行结果。

jobType

String

参数解释:

任务类型。

取值范围:

• FULL：版本级任务。

• INC_GIT：门禁级任务。

- INC_COMMIT：流水线指定commitId增量检查、代码检查任务设置-检查范围-版本级检查模式的最近一次提交检查。

- INC_LAST_SUCCESS_COMMIT：流水线指定commitId以及最后一次门禁成功的commitId间的增量检查。

process

ProcessInfo object

参数解释：

执行记录信息。

reviewResult

String

参数解释：

门禁结果。

取值范围：

• success：门禁通过。

• error：门禁未通过。

ruleSets

Array of ConfigTemplateRuleSetInfo objects

参数解释：

规则集配置列表。

source

String

参数解释：

执行来源。

取值范围：

• customer：来自页面点击。

• Scheduled：来自定时任务。

• CodeCheckEdge：来自Edge服务。

• CodeArtsPipeline：来自流水线。

• DevCloudWebhook：来自CodeArtsRepo的Webhook。

• GitCodeActionPipeline：来自流水线的GitCodeAction插件。

sourceRepoUrl

String

参数解释：

源分支的代码仓地址。

取值范围：

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

startTime

String

参数解释：

执行记录的检查开始时间，使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ，例如"2025-11-28T06:55:41Z"。

取值范围：

不涉及。

status

String

参数解释:

任务执行状态。

取值范围:

• quering：初始状态。

• running：执行中。

• success：检查成功。

• failed：检查失败。

• aborted：任务中止。

subJobIds

Array of strings

参数解释：

子任务ID，该字段一般返回空数组[]。

subJobStatuses

Array of strings

参数解释：

子任务状态，该字段一般返回空数组[]。

targetRepoUrl

String

参数解释：

目标分支的代码仓地址。

取值范围：

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

taskId

String

参数解释：

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

取值范围：

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

totalExecuteTime

String

参数解释：

任务总执行时长，格式为%dm%ds，例如"6m6s"。

取值范围：

不涉及。

CRITICAL

Integer

参数解释：

严重问题数。

取值范围：

≥0

DELAYSTATUS_COUNT

Integer

参数解释：

延迟上线问题数。

取值范围：

≥0

FATAL

Integer

参数解释：

致命问题数。

取值范围：

≥0

GENERAL

Integer

参数解释：

一般问题数。

取值范围：

≥0

INFO

Integer

参数解释：

信息问题数。

取值范围：

≥0

PROMPT

Integer

参数解释：

提示问题数。

取值范围：

≥0

codeLine

Integer

参数解释：

扫描代码行数，不包括空行和注释行。

取值范围：

≥0

defectCount

Integer

参数解释：

缺陷总数。

取值范围：

≥0

dismissed

Integer

参数解释：

已忽略问题数。

取值范围：

≥0

fileTotal

Integer

参数解释：

文件总数。

取值范围：

≥0

fixed

Integer

参数解释：

已修复问题数。

取值范围：

≥0

id

String

参数解释：

执行ID，来自代码检查执行任务接口的返回值，每次执行代码检查任务都有唯一的执行ID。

取值范围：

不涉及。

jobId

String

参数解释：

执行ID，来自代码检查执行任务接口的返回值，每次执行代码检查任务都有唯一的执行ID。

取值范围：

不涉及。

newUnsolvedDefectCount

Integer

参数解释：

未解决且新增的问题数。

取值范围：

≥0

nonSecurityDefectCount

Integer

参数解释：

非安全问题数。

取值范围：

≥0

reviewResult

String

参数解释：

门禁结果。

取值范围：

• success：门禁通过。

• error：门禁未通过。

securityDefectCount

Integer

参数解释：

安全问题数。

取值范围：

≥0

solvedDefectCount

Integer

参数解释：

已解决的问题数。

取值范围：

不涉及。

unsolvedDefectCount

Integer

参数解释：

未解决的问题数。

取值范围：

不涉及。

exeTime

String

参数解释：

执行时间，单位为秒。

取值范围：

不涉及。

executeTime

String

参数解释：

执行时间，格式为%dm%ds，例如"6m6s"。

取值范围：

不涉及。

message

String

参数解释：

执行过程。

取值范围：

不涉及。

process

String

参数解释：

任务执行的进度百分比。

取值范围：

不涉及。

status

String

参数解释:

任务执行状态。

取值范围:

• quering：初始状态。

• running：执行中。

• success：检查成功。

• failed：检查失败。

• aborted：任务中止。

language

String

参数解释：

语言类型。

取值范围：

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

• ARKTS

• C#

• CANGJIE

• C++

• CSS

• GO

• HTML

• JAVA

• JAVASCRIPT

• KOTLIN

• LUA

• PHP

• PYTHON

• RUST

• SCALA

• SHELL

• SQL

• TERRAFORM

• TYPESCRIPT

ruleSetId

String

参数解释：

规则集ID。

取值范围：

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

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

200

请求成功!

400

请求异常。

401

权限不足。