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

查询任务列表

功能介绍

查询任务列表

调用方法

请参见如何调用API

URI

GET /v1/tasks

表1 Query参数

参数

是否必选

参数类型

描述

page

Integer

参数解释:

页数。

约束限制:

不涉及。

取值范围:

≥1。

默认取值:

不涉及。

page_size

Integer

参数解释:

每页大小。

约束限制:

不涉及。

取值范围:

  • 最小值:1。

  • 最大值:200。

默认取值:

不涉及。

search

String

参数解释:

需要搜索的任务名。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

project_id

String

参数解释:

项目id,通过查询项目列表接口查询项目列表获取。

约束限制:

不涉及。

取值范围:

32位uuid。

默认取值:

不涉及。

review_result_types

String

参数解释:

门禁结果。

约束限制:

不涉及。

取值范围:

  • success:门禁通过。

  • error:门禁不通过。

默认取值:

不涉及。

job_status_types

String

参数解释:

检查状态。

约束限制:

不涉及。

取值范围:

  • success:检查成功。

  • failed:检查失败。

  • aborted:检查终止。

  • executing:检查中。

  • never_execute:未检查。

默认取值:

不涉及。

order_by_execute_time

String

参数解释:

是否按照执行时间排序。

约束限制:

不涉及。

取值范围:

  • up:按照执行时间升序排序。

  • down:按照执行时间降序排序。

默认取值:

不涉及。

task_classification_id

String

参数解释:

任务的分组ID,可通过列出项目下的分组信息接口获取任务的分组ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

httpStatus

String

参数解释:

HTTP响应状态,接口响应成功时为"OK",接口响应失败时为其他HTTP状态码。如INTERNAL_SERVER_ERROR为接口内部异常,BAD_REQUEST是参数校验异常。

取值范围:

  • OK,接口响应成功。

  • ACCEPTED,接口响应成功。

  • INTERNAL_SERVER_ERROR,接口内部异常。

  • BAD_REQUEST,参数校验异常。

result

ShowTasksListResult object

参数解释:

任务列表响应。

取值范围:

不涉及。

status

String

参数解释:

接口响应状态。

取值范围:

  • success,接口响应成功。

  • error,接口响应失败。

表3 ShowTasksListResult

参数

参数类型

描述

info

Array of TaskBasicInfo objects

参数解释:

任务列表。

取值范围:

不涉及。

total

Integer

参数解释:

代码检查任务总数。

取值范围:

不涉及。

表4 TaskBasicInfo

参数

参数类型

描述

branchName

String

参数解释:

分支名称。

取值范围:

不涉及。

canDelete

Boolean

参数解释:

是否有删除的权限。

取值范围:

true:有,false:没有。

canEdit

Boolean

参数解释:

是否有编辑的权限。

取值范围:

true:有,false:没有。

canExecute

Boolean

参数解释:

是否有执行的权限。

取值范围:

true:有,false:没有。

canRead

Boolean

参数解释:

是否有读的权限。

取值范围:

true:有,false:没有。

configTemplate

ConfigTemplateBasicInfo object

configTemplateId

String

参数解释:

任务的配置模板的id。

取值范围:

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

createTime

String

参数解释:

任务的创建时间,格式为UTC时间。

取值范围:

不涉及。

id

String

参数解释:

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

取值范围:

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

isFollowed

Boolean

参数解释:

任务是否被关注。任务被关注时为true,任务未被关注时为false。

取值范围:

true、false。

jobResult

JobResultInfo object

参数解释:

执行结果。

取值范围:

不涉及。

lastJob

JobBasicInfo object

参数解释:

执行记录信息。

取值范围:

不涉及。

lastUpdateTime

String

参数解释:

任务的上一次更新时间,格式为UTC时间。

取值范围:

不涉及。

name

String

参数解释:

代码检查任务名。

取值范围:

不涉及。

owner

String

参数解释:

代码检查任务所有者。

取值范围:

不涉及。

projectId

String

参数解释:

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

取值范围:

字符串长度32。

projectName

String

参数解释:

项目名。

取值范围:

不涉及。

region

String

参数解释:

华为云地域。

取值范围:

不涉及。

repoUrl

String

参数解释:

代码仓地址。

取值范围:

不涉及。

ruleSets

Array of ConfigTemplateRuleSetInfo objects

参数解释:

规则集配置列表。

取值范围:

不涉及。

ruleType

String

参数解释:

任务类型,普通任务为basic,安全增强包任务为security。

取值范围:

basic、security。

taskGroupId

String

参数解释:

任务分组的id。

取值范围:

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

表5 ConfigTemplateBasicInfo

参数

参数类型

描述

arch

String

参数解释:

执行机类型。

取值范围:

X86/ARM。

branch

String

参数解释:

分支名。

取值范围:

不涉及。

createTime

String

参数解释:

配置模板创建时间,格式为UTC时间。

取值范围:

不涉及。

creator

String

参数解释:

配置模板创建者。

取值范围:

不涉及。

exclude

String

参数解释:

任务配置的排除目录信息。

取值范围:

不涉及。

id

String

参数解释:

配置模板ID,修改配置信息需要用到配置模板id,每个CodeArtsCheck任务及其下的分支任务都有1个相同的且唯一的配置模板ID。

取值范围:

不涉及。

includePaths

String

参数解释:

检查目录。不配置检查目录时,检查代码仓中所有目录下的代码文件;配置检查目录时,只检查配置目录中的文件。

取值范围:

不涉及。

lastReviser

String

参数解释:

最后修改人的用户名。

取值范围:

不涉及。

lastUpdateTime

String

参数解释:

配置模板上一次修改时间,格式为UTC时间。

取值范围:

不涉及。

name

String

参数解释:

配置模板的名称。

取值范围:

不涉及。

projectId

String

参数解释:

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

取值范围:

字符串长度32。

projectName

String

参数解释:

项目名。

取值范围:

不涉及。

region

String

参数解释:

华为云地域。

取值范围:

不涉及。

repoType

String

参数解释:

代码仓类型。DevCloud为CodeArtsRepo仓,Gitee为Gitee仓,GitHub为GitHub仓,GitPub为通用git仓,gitcode为GitCode仓,gitlab为GitLab仓,self_gitlab为自建GitLab仓,tfs_git为TFS仓,bitbucket为Bitbucket仓。

取值范围:

DevCloud、Gitee、GitHub、GitPub、gitcode、gitlab、self_gitlab、tfs_git、bitbucket。

repoUrl

String

参数解释:

代码仓地址。

取值范围:

不涉及。

resourcePoolId

String

参数解释:

启用的资源池id,使用内置执行机的情况下为""。

取值范围:

不涉及。

resourcePoolName

String

参数解释:

启用的资源池名称,使用内置执行机的情况下为空。

取值范围:

不涉及。

resource_pool_type

String

参数解释:

启用的资源池名称,使用内置资源池时为default,使用专属资源池时为exclusive,使用自定义资源池时为self-hosted。

取值范围:

default、exclusive、self-hosted。

reviewData

Array of ReviewDataInfoResponse objects

参数解释:

任务门禁配置列表。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

reviewDataJson

String

参数解释:

任务门禁配置列表的json字符串。

取值范围:

不涉及。

ruleSets

Array of ConfigTemplateRuleSetInfo objects

参数解释:

规则集配置列表。

取值范围:

不涉及。

表6 ReviewDataInfoResponse

参数

参数类型

描述

compareType

String

参数解释:

运算逻辑。

取值范围:

取值为"≤"。

isCheck

Integer

参数解释:

门禁开关。

取值范围:

0:关闭门禁,1:打开门禁。

name

String

参数解释:

门禁项。

取值范围:

致命问题数。

严重问题数。

一般问题数。

提示问题数。

value

Integer

参数解释:

门禁阈值。

取值范围:

≥0。

表7 JobBasicInfo

参数

参数类型

描述

executor

String

参数解释:

执行人用户名。

取值范围:

不涉及。

finishTime

String

参数解释:

执行记录的检查完成时间,格式为UTC时间。

取值范围:

不涉及。

jobResult

JobResultInfo object

参数解释:

执行结果。

取值范围:

不涉及。

jobType

String

参数解释:

任务类型。

取值范围:

  • FULL:版本级任务。

  • INC_GIT:门禁级任务。

  • INC_COMMIT:流水线指定commitId增量检查。

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

process

ProcessInfo object

参数解释:

执行记录信息。

取值范围:

不涉及。

startTime

String

参数解释:

执行记录的检查开始时间,格式为UTC时间。

取值范围:

不涉及。

status

String

参数解释:

任务执行状态。

取值范围:

  • quering:初始状态。

  • running:执行中。

  • success:检查成功。

  • failed:检查失败。

  • aborted:任务中止。

taskId

String

参数解释:

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

取值范围:

不涉及。

表8 JobResultInfo

参数

参数类型

描述

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,来自代码检查执行任务接口的返回值,每次执行代码检查任务都有1个唯一的执行ID。

取值范围:

不涉及。

jobId

String

参数解释:

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

取值范围:

不涉及。

newUnsolvedDefectCount

Integer

参数解释:

未解决且新增的问题数。

取值范围:

≥0。

nonSecurityDefectCount

Integer

参数解释:

非安全问题数。

取值范围:

≥0。

reviewResult

String

参数解释:

门禁结果。

取值范围:

  • success:门禁通过。

  • error:门禁未通过。

securityDefectCount

Integer

参数解释:

安全问题数。

取值范围:

≥0。

solvedDefectCount

Integer

参数解释:

已解决的问题数。

取值范围:

不涉及。

unsolvedDefectCount

Integer

参数解释:

未解决的问题数。

取值范围:

不涉及。

表9 ProcessInfo

参数

参数类型

描述

exeTime

String

参数解释:

执行时间,单位为秒。

取值范围:

不涉及。

executeTime

String

参数解释:

执行时间,格式为%dm%ds。

取值范围:

不涉及。

message

String

参数解释:

执行过程。

取值范围:

不涉及。

process

String

参数解释:

任务执行的进度百分比。

取值范围:

不涉及。

status

String

参数解释:

任务执行状态。

取值范围:

  • quering:初始状态。

  • running:执行中。

  • success:检查成功。

  • failed:检查失败。

  • aborted:任务中止。

表10 ConfigTemplateRuleSetInfo

参数

参数类型

描述

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。

取值范围:

不涉及。

状态码:400

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

查询项目id为685ddb216a12457593569a753e4d5573的项目的代码检查任务列表。

GET https://{endpoint}/v1/tasks?project_id=685ddb216a12457593569a753e4d5573

响应示例

状态码:200

展示任务列表

{
  "httpStatus" : "OK",
  "result" : {
    "info" : [ {
      "avastarType" : "pure-green",
      "branchName" : "master",
      "canDelete" : true,
      "canEdit" : true,
      "canExecute" : true,
      "canRead" : true,
      "checkParamList" : [ ],
      "configTemplate" : {
        "arch" : "X86",
        "branch" : "master",
        "checkersVersions" : [ ],
        "configImageMappings" : [ ],
        "createTime" : "2024-10-30T08:43:41Z",
        "creator" : "codecheck_gray02",
        "customParams" : [ ],
        "delayTime" : [ ],
        "engines" : [ ],
        "exclude" : "",
        "groups" : "",
        "id" : "107fc738969b11ef8ce6fa163e4dad77",
        "includePaths" : "",
        "lastReviser" : "codecheck_gray02",
        "lastUpdateTime" : "2024-10-30T08:43:41Z",
        "manifestFile" : "",
        "matchRepos" : "",
        "modelSets" : [ ],
        "name" : "template_107fc738969b11ef8ce6fa163e4dad77",
        "parentId" : "",
        "projectId" : "edd273b35def47278140367342aeb5e3",
        "projectName" : "引擎基线用例_勿动",
        "region" : "suzhou",
        "repoType" : "DevCloud",
        "repoUrl" : "git@codehub.devcloud.cn-north-5.huaweicloud.com:edd273b35def47278140367342aeb5e3/engine_codemars_guiyi_java.git",
        "resourcePoolId" : "",
        "resourcePoolName" : "",
        "resource_pool_type" : "",
        "reviewData" : [ {
          "compareType" : "≤",
          "isCheck" : 1,
          "name" : "致命问题数",
          "value" : 0
        }, {
          "compareType" : "≤",
          "isCheck" : 1,
          "name" : "严重问题数",
          "value" : 0
        }, {
          "compareType" : "≤",
          "isCheck" : 0,
          "name" : "一般问题数",
          "value" : 0
        }, {
          "compareType" : "≤",
          "isCheck" : 0,
          "name" : "提示问题数",
          "value" : 0
        } ],
        "reviewDataJson" : "[{\"compareType\":\"≤\",\"isCheck\":1,\"name\":\"致命问题数\",\"value\":0},{\"compareType\":\"≤\",\"isCheck\":1,\"name\":\"严重问题数\",\"value\":0},{\"compareType\":\"≤\",\"isCheck\":0,\"name\":\"一般问题数\",\"value\":0},{\"compareType\":\"≤\",\"isCheck\":0,\"name\":\"提示问题数\",\"value\":0}]",
        "ruleSets" : [ {
          "language" : "JAVA",
          "ruleSetId" : "d2feb9c786054a8aa93ffc10dabb0b2b"
        } ],
        "toolImage" : "",
        "toolVersionId" : "",
        "type" : "private",
        "versionUpdateDelayDays" : [ ],
        "ymlPath" : "",
        "zone" : "green"
      },
      "configTemplateId" : "107fc738969b11ef8ce6fa163e4dad77",
      "createTime" : "2024-10-30T08:43:41Z",
      "criterionSets" : [ ],
      "customParams" : [ ],
      "id" : "51c9e8f2af4d49769c4e47e31243a3fd",
      "isDelete" : 1,
      "isFollowed" : true,
      "jobId" : "676672b0933e4c18a04e22d2df896364",
      "jobNum" : 0,
      "jobResult" : {
        "DELAYSTATUS_COUNT" : 0,
        "codeLine" : 616213,
        "defectCount" : 181187,
        "id" : "676672b0933e4c18a04e22d2df896364",
        "jobId" : "676672b0933e4c18a04e22d2df896364",
        "newUnsolvedDefectCount" : 6,
        "nonSecurityDefectCount" : 0,
        "reviewResult" : "error",
        "securityDefectCount" : 0,
        "solvedDefectCount" : 0,
        "unsolvedDefectCount" : 181187
      },
      "lastJob" : {
        "executor" : "codecheck_gray02",
        "finishTime" : "2025-09-12T08:41:26Z",
        "id" : "676672b0933e4c18a04e22d2df896364",
        "jobResult" : {
          "DELAYSTATUS_COUNT" : 0,
          "codeLine" : 616213,
          "defectCount" : 181187,
          "id" : "676672b0933e4c18a04e22d2df896364",
          "jobId" : "676672b0933e4c18a04e22d2df896364",
          "newUnsolvedDefectCount" : 6,
          "nonSecurityDefectCount" : 0,
          "reviewResult" : "error",
          "securityDefectCount" : 0,
          "solvedDefectCount" : 0,
          "unsolvedDefectCount" : 181187
        },
        "jobType" : "FULL",
        "process" : {
          "exeTime" : "468",
          "executeTime" : "7m48s",
          "message" : "2025/09/12 16:38:12 GMT+08:00 Running on server:21.102.***.***\n2025/09/12 16:38:13 GMT+08:00 waiting subJob to execute\n2025/09/12 16:41:17 GMT+08:00 start sync fixed defect snapshotData!\n2025/09/12 16:41:20 GMT+08:00 sync defect SnapshotData success!\n2025/09/12 16:41:21 GMT+08:00 flush redis cache successfully!\n2025/09/12 16:41:21 GMT+08:00 [WARNING]  : Some languages in the code are not checked! Languages in code: [SQL, SHELL], while in rules: [JAVA]\n2025/09/12 16:41:21 GMT+08:00 all subJob finish!\n",
          "process" : "100%",
          "status" : "success"
        },
        "ruleSets" : [ ],
        "startTime" : "2025-09-12T08:33:34Z",
        "status" : "success",
        "subJobIds" : [ ],
        "subJobStatuses" : [ ],
        "taskId" : "51c9e8f2af4d49769c4e47e31243a3fd"
      },
      "lastUpdateTime" : "2024-10-30T08:43:41Z",
      "modelSets" : [ ],
      "name" : "引擎任务_ydf_云端新增P3C默认规则集",
      "owner" : "codecheck_gray02",
      "projectId" : "edd273b35def47278140367342aeb5e3",
      "projectName" : "引擎基线用例_勿动",
      "region" : "suzhou",
      "repoUrl" : "git@codehub.devcloud.cn-north-5.huaweicloud.com:edd273b35def47278140367342aeb5e3/engine_codemars_guiyi_java.git",
      "reviewData" : [ ],
      "ruleSets" : [ {
        "language" : "JAVA",
        "ruleSetId" : "d2feb9c786054a8aa93ffc10dabb0b2b"
      } ],
      "ruleType" : "basic",
      "tags" : "",
      "taskGroupId" : "65659ed7e5094e07bae22b93630f516d",
      "taskIds" : [ ],
      "zone" : "green"
    } ],
    "total" : 2631
  },
  "status" : "success"
}

状态码:400

Bad Request

{
  "error_code" : "CC.00000000",
  "error_msg" : "网络繁忙,请稍后再试"
}

状态码:401

Unauthorized

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

状态码

状态码

描述

200

展示任务列表

400

Bad Request

401

Unauthorized

错误码

请参见错误码

相关文档