# 执行全量检查 - CreateJob #### 功能介绍 根据任务ID对任务所在的分支执行一次版本级检查，返回任务ID、执行记录ID和执行人等信息。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-codecheck/codecheck_03_0006.html)。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-codecheck/Permission.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | codeartscheck:task:execute | Write | task \* | - | - | - | | codeartscheck:task:execute | Write | - | codeartscheck:ProjectId | - | - | #### URI POST /v1/jobs #### 请求参数 表1请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及。 **取值范围：** 长度为\[1\~100000\]的字符。 **默认取值：** 不涉及。 | | Content-Type | 是 | String | **参数解释：** 编码格式。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** application/json，传任何值，接口返回值均为json格式。 | | operator | 否 | String | **参数解释：** 代码检查任务执行人的用户名。 **约束限制：** 不涉及。 **取值范围：** 长度为\[1\~255\]个字符。 **默认取值：** 不涉及。 | 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | taskId | 是 | String | **参数解释：** 任务ID，即新建检查任务接口的返回值，每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即[查询任务列表](https://support.huaweicloud.com/api-codecheck/ShowTasksList.html)接口响应中的id字段。 **约束限制：** 不涉及。 **取值范围：** 长度为\[1\~32\]个字符。 **默认取值：** 不涉及。 | | executor | 否 | String | **参数解释:** 代码检查执行人。 **约束限制：** 不涉及。 **取值范围:** 长度为\[1\~255\]个字符。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | httpStatus | String | **参数解释：** HTTP响应状态。 **取值范围：** - OK：请求已成功处理，服务器返回了请求的资源或操作结果。 - ACCEPTED：请求已被服务器接受，但处理尚未完成（通常用于异步操作）。 - INTERNAL_SERVER_ERROR：接口内部异常。 - BAD_REQUEST：参数校验异常。 | | result | [CreateJobResult] object | **参数解释：** 执行全量检查返回的信息。 | | status | String | **参数解释：** 接口响应状态。 **取值范围：** - success：接口响应成功。 - error：接口响应失败。 | 表4CreateJobResult | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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，即新建检查任务接口的返回值，每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即[查询任务列表](https://support.huaweicloud.com/api-codecheck/ShowTasksList.html)接口响应中的id字段。 **取值范围：** 长度为\[1\~32\]个字符。 | | tenantId | String | **参数解释：** 任务所属的租户的租户ID，租户ID的值来源于IAM的租户ID。 **取值范围：** 不涉及。 | | tokenUser | String | **参数解释：** 代码检查任务执行人的用户ID，用户ID的值来源于IAM的用户ID。 **取值范围：** 长度为\[1\~64\]个字符。 | | version | String | **参数解释：** 代码检查任务的版本。 **取值范围：** 长度为\[1\~64\]个字符。 | 表5JobProcess | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | **参数解释：** 子任务状态。 | 表6StageStatus | 参数 | 参数类型 | 描述 | |:---|:---|:---| | executeTime | String | **参数解释:** 代码检查任务的执行时长。 **取值范围:** 不涉及。 | | message | String | **参数解释:** 代码检查任务的执行进度。 **取值范围:** 不涉及。 | | stageName | String | **参数解释:** 代码检查任务的阶段名称。 **取值范围:** 不涉及。 | | status | String | **参数解释:** 任务执行状态。 **取值范围:** - quering：初始状态。 - running：执行中。 - success：检查成功。 - failed：检查失败。 - aborted：任务中止。 | 表7ConfigTemplateRuleSetInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | language | String | **参数解释：** 语言类型。 **取值范围：** 自定义语言或者系统内置语言，当前支持的系统内置语言有： - ARKTS - C# - CANGJIE - C++ - CSS - GO - HTML - JAVA - JAVASCRIPT - KOTLIN - LUA - PHP - PYTHON - RUST - SCALA - SHELL - SQL - TERRAFORM - TYPESCRIPT - AZURERESOURCEMANAGER - DOCKER - KUBERNETES | | ruleSetId | String | **参数解释：** 规则集ID。 **取值范围：** 长度为\[1\~32\]个字符。 | **状态码：400** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | **状态码：401** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | #### 请求示例 对任务ID为1015xxxxxxx6702d的任务执行一次全量扫描，任务执行人为codecheck_test。 ``` POST https://{endpoint}/v1/jobs { "taskId" : "1015xxxxxxx6702d", "executor" : "codecheck_test" } ``` #### 响应示例 **状态码：200** 执行任务成功。 ``` { "httpStatus" : "OK", "result" : { "finishTime" : "2025-09-23 09:24:54", "hwCloudRegion" : "region-example", "id" : "b9a249a06xxxxx14a9c59", "process" : { "message" : "任务初始化中...", "process" : "0%", "rate" : "0%", "stageStatuses" : [ { "executeTime" : "<5s", "message" : "任务初始化中...", "stageName" : "init", "status" : "running" } ], "status" : "pending", "subJobIds" : [ ], "subJobStatuses" : [ ] }, "ruleSets" : [ ], "source" : "customer", "startTime" : "2025-09-23T01:24:54Z", "status" : "quering", "subJobIds" : [ ], "subJobStatuses" : [ ], "taskGroupId" : "4bbeb9xxxxbba18c8", "taskId" : "6309exxxxxc8d2ad", "tenantId" : "389efb7xxxxxc895e4", "tokenUser" : "405054xxxxxx0a09", "version" : 2 }, "status" : "success" } ``` **状态码：400** 请求异常。 ``` { "error_code" : "CC.xxxxxxxx.400", "error_msg" : "请求参数校验失败,请检查请求参数是否正确" } ``` **状态码：401** 权限不足。 ``` { "error_code" : "CC.00000003", "error_msg" : "认证信息过期" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 执行任务成功。 | | 400 | 请求异常。 | | 401 | 权限不足。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-codecheck/ErrorCode.html)。