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

查询项目任务列表

功能介绍

查询项目任务列表

调用方法

请参见如何调用API。

URI

GET /v1/job/{project_id}/list

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

CodeArts项目ID，32位数字、小写字母组合。
表2 Query参数

参数

是否必选

参数类型

描述

page_index

是

Integer

分页页码， 表示从此页开始查询， page_index大于等于1

默认取值：

1

page_size

是

Integer

每页显示的条目数量，page_size小于等于100

默认取值：

10

search

否

String

查询条件

sort_field

否

String

排序的字段

sort_order

否

String

排序顺序

creator_id

否

String

创建人ID

build_status

否

String

构建状态过滤条件

by_group

否

Boolean

是否分组

group_path_id

否

String

分组ID

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

jobs

Array of Job objects

任务列表

total

Integer

任务总数
表4 Job

参数

参数类型

描述

id

String

任务ID

job_name

String

任务名称

job_creator

String

任务创建者

user_name

String

用户名称

last_build_time

Number

最新执行时间

health_score

Integer

健康分值

source_code

String

代码来源

last_build_status

String

最新构建状态

is_finished

Boolean

是否已结束

disabled

Boolean

是否已禁用

favorite

Boolean

是否已收藏

is_modify

Boolean

是否有修改任务权限

is_delete

Boolean

是否有删除任务权限

is_execute

Boolean

是否有执行任务权限

is_copy

Boolean

是否有复制任务权限

is_forbidden

Boolean

是否有禁用任务权限

is_view

Boolean

是否有查看任务权限

last_build_user

String

最后一次构建用户

trigger_type

String

触发类型

build_time

String

构建时间

scm_web_url

String

代码仓web地址

scm_type

String

代码仓类型

repo_id

String

代码仓ID

build_project_id

String

构建项目ID

last_job_running_status

String

最后一次构建时间

last_build_user_id

String

最后一次构建用户ID

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

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

响应示例

状态码： 200

OK

{
  "total" : 1,
  "jobs" : [ {
    "id" : "2a86c3c1ed18416399279fe6........",
    "job_name" : "demo",
    "job_creator" : "ae22fd035f354cfa8d82a3f1........",
    "user_name" : "test",
    "last_build_time" : 1608004535000,
    "health_score" : 75,
    "source_code" : "test",
    "last_build_status" : "blue",
    "is_finished" : true,
    "disabled" : true,
    "favorite" : true,
    "is_modify" : true,
    "is_delete" : true,
    "is_execute" : true,
    "is_copy" : true,
    "is_forbidden" : true,
    "is_view" : true
  } ]
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 任务相关API接口

相关文档