文档首页/ 编译构建 CodeArts Build/ API参考/ 任务相关API接口/ 查看用户全部的构建任务列表
更新时间：2024-11-08 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查看用户全部的构建任务列表

功能介绍

查看用户全部的构建任务列表

调用方法

请参见如何调用API。

URI

GET /v1/job/list

请求参数

无

响应参数

状态码： 200

表1 响应Body参数

参数

参数类型

描述

result

result object

返回结果

status

String

返回状态信息
表2 result

参数

参数类型

描述

total

Integer

任务总数

job_list

Array of job_list objects

任务列表
表3 job_list

参数

参数类型

描述

id

String

任务ID

job_name

String

任务名称

job_creator

String

任务创建者

user_id

String

用户id

user_name

String

用户名

nick_name

String

用户昵称

project_id

String

构建任务所在项目的ID

project_name

String

构建任务所在项目的名称

last_build_time

Number

最新执行时间

health_score

Integer

健康分值

source_code

String

代码来源

last_build_status

String

最新构建状态

last_job_running_status

String

最新运行状态

last_build_user

String

执行用户

last_build_user_id

String

执行用户ID

is_finished

Boolean

是否已结束

disabled

Boolean

是否已禁用

favorite

Boolean

是否已收藏

is_modify

Boolean

是否有修改任务权限

is_delete

Boolean

是否有删除任务权限

is_view

Boolean

是否有查看任务权限

is_execute

Boolean

是否有执行任务权限

is_copy

Boolean

是否有复制任务权限

is_forbidden

Boolean

是否有禁用任务权限

task_id

String

任务记录编号

code_branch

String

代码分支

commit_id

String

代码提交ID

trigger_type

String

触发类型

build_time

Number

执行时间

scm_web_url

String

代码源地址

scm_type

String

仓库类别，Repo、Github等

repo_id

String

repo的id

commit_detail_url

String

代码提交记录信息地址（代码源为Repo)

build_number

String

构建编号

forbidden_msg

String

禁用消息

build_project_id

String

构建工程ID,唯一对应codeci_job_id

build_type

String

构建类别

tag

String

仓库tag

project_permission_switch

Boolean

使用项目权限

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 401

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 404

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET https://{endpoint}/v1/job/list

响应示例

状态码： 200

OK

{
  "result" : {
    "total" : 20697,
    "job_list" : [ {
      "id" : "8f4fb54a55c744beb8967cf50d96d87b",
      "job_name" : "APITest-JobList-running-2kDRoU",
      "job_creator" : "ae22fd035f354cfa8d82a3f1c8940446",
      "user_id" : "ae22fd035f354cfa8d82a3f1c8940446",
      "user_name" : "testUser",
      "project_id" : "6823252f543d4915b49892a5fd9f0ec3",
      "project_name" : "CodeCIServer—API测试01",
      "last_build_time" : 1727041445000,
      "health_score" : 0,
      "source_code" : "codeci",
      "last_build_status" : "aborted",
      "last_job_running_status" : "Finished",
      "last_build_user" : "testUser",
      "last_build_user_id" : "ae22fd035f354cfa8d82a3f1c8940446",
      "is_finished" : true,
      "disabled" : false,
      "favorite" : false,
      "is_modify" : true,
      "is_delete" : true,
      "is_execute" : true,
      "is_copy" : true,
      "is_forbidden" : true,
      "is_view" : true,
      "task_id" : "#20240923.1",
      "commit_id" : "",
      "trigger_type" : "Manual",
      "build_time" : 0,
      "scm_type" : "codehub",
      "repo_id" : "",
      "commit_detail_url" : "",
      "build_number" : "1",
      "forbidden_msg" : "",
      "build_project_id" : "8597a528-068e-4bfa-a812-3c625060c007",
      "project_permission_switch" : false
    } ]
  },
  "status" : "success"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 任务相关API接口

相关文档