执行全量检查 - CreateJob

codeartscheck:task:execute

Write

task *

-

-

-

-

codeartscheck:ProjectId

operator

否

String

参数解释：

代码检查任务执行人的用户名。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

taskId

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

executor

否

String

参数解释:

代码检查执行人。

约束限制：

不涉及。

取值范围:

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

默认取值：

不涉及。

httpStatus

String

参数解释：

HTTP响应状态。

取值范围：

• OK，接口响应成功。

• ACCEPTED，接口响应成功。

• INTERNAL_SERVER_ERROR，接口内部异常。

• BAD_REQUEST，参数校验异常。

result

CreateJobResult object

参数解释：

执行全量检查返回的信息。

status

String

参数解释：

接口响应状态。

取值范围：

• success，接口响应成功。

• error，接口响应失败。

finishTime

String

参数解释：

执行记录的检查完成时间，格式为yyyy-MM-dd HH:mm:ss。

取值范围：

不涉及。

hwCloudRegion

String

参数解释：

华为云地域。

取值范围:

不涉及。

id

String

参数解释：

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

取值范围：

不涉及。

process

JobProcess object

参数解释：

代码检查任务的执行进度。

取值范围：

不涉及。

ruleSets

Array of ConfigTemplateRuleSetInfo objects

参数解释：

规则集配置列表。

取值范围：

不涉及。

source

String

参数解释：

执行来源。

取值范围：

• customer：来自页面点击。

• Scheduled：来自定时任务。

• CodeCheckEdge：来自Edge服务。

• CodeArtsPipeline：来自流水线。

• DevCloudWebhook：来自CodeArtsRepo的Webhook。

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

startTime

String

参数解释：

执行记录的检查开始时间，使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。

取值范围：

不涉及。

status

String

参数解释:

任务执行状态。

取值范围:

• quering：初始状态。

• running：执行中。

• success：检查成功。

• failed：检查失败。

• aborted：任务中止。

subJobIds

Array of strings

参数解释：

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

subJobStatuses

Array of strings

参数解释：

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

taskGroupId

String

参数解释：

任务分组的ID。

取值范围：

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

taskId

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

tenantId

String

参数解释：

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

取值范围：

不涉及。

tokenUser

String

参数解释：

代码检查任务执行人的用户ID，用户ID的值来源于IAM的用户ID。

取值范围：

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

version

String

参数解释：

代码检查任务的版本。

取值范围：

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

message

String

参数解释:

代码检查任务的执行进度。

取值范围:

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

process

String

参数解释：

任务执行的进度百分比。

取值范围：

从0%到100%。

rate

String

参数解释：

任务执行的进度百分比。

取值范围：

从0%到100%。

stageStatuses

Array of StageStatus objects

参数解释：

代码检查任务的阶段状态。

status

String

参数解释:

任务执行状态。

取值范围:

• quering：初始状态。

• running：执行中。

• success：检查成功。

• failed：检查失败。

• aborted：任务中止。

subJobIds

Array of strings

参数解释：

子任务ID。

取值范围：

不涉及。

subJobStatuses

Array of strings

参数解释：

子任务状态。

取值范围：

不涉及。

executeTime

String

参数解释:

代码检查任务的执行时长。

取值范围:

不涉及。

message

String

参数解释:

代码检查任务的执行进度。

取值范围:

不涉及。

stageName

String

参数解释:

代码检查任务的阶段名称。

取值范围:

不涉及。

status

String

参数解释:

任务执行状态。

取值范围:

• quering：初始状态。

• running：执行中。

• success：检查成功。

• failed：检查失败。

• aborted：任务中止。

language

String

参数解释：

语言类型。

取值范围：

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

ruleSetId

String

参数解释：

规则集ID。

取值范围：

不涉及。

error_code

String

错误码

error_msg

String

错误描述

error_code

String

错误码

error_msg

String

错误描述

200

执行任务成功。

400

Bad Request

401

Unauthorized