查询通用任务列表 - ListReusableJobs
功能介绍
查询通用任务列表，主要包括通用任务的重要信息。
调用方法
请参见如何调用API。
URI
POST /v5/{project_id}/api/reusable-jobs/list
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释： CodeArts项目的32位UUID，项目唯一标识。 约束限制： 不涉及。 取值范围： 32位字符。 默认取值： 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| offset | 否 | Integer | 参数解释： 偏移量，表示从此偏移量开始查询。 约束限制： 不涉及。 取值范围： offset大于等于0。 默认取值： 不涉及。 |
| limit | 否 | Integer | 参数解释： 每次查询的条目数量。 约束限制： 不涉及。 取值范围： 大于等于0。 默认取值： 不涉及。 |
| sort_key | 否 | String | 参数解释： 排序字段。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
| sort_dir | 否 | String | 参数解释： 排序方向。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
| name | 否 | String | 参数解释： 模糊查询名称。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| offset | Integer | 偏移量 |
| limit | Integer | 单次查询数目 |
| total | Integer | 总数 |
| reusable_jobs | Array of reusable_jobs objects | 任务列表 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 任务id |
| name | String | 任务名称 |
| description | String | 任务描述 |
| domain_id | String | 租户id |
| region | String | 局点信息 |
| project_id | String | 项目id |
| steps | Array of steps objects | 步骤列表 |
| deleted | Boolean | 是否已删除 |
| enabled | Boolean | 是否启用 |
| creator_id | String | 创建者id |
| updater_id | String | 更新人id |
| updater_name | String | 更新人名称 |
| creator_name | String | 创建者名称 |
| create_time | Integer | 创建时间 |
| update_time | Integer | 更新时间 |
请求示例
POST https://{endpoint}/v5/0493899d9e6644cba4583c778443fad0/api/reusable-jobs/list
{
"offset" : 0,
"limit" : 10,
"name" : "",
"sort_key" : "create_time",
"sort_dir" : "desc"
} 响应示例
状态码：200
{
"offset" : 0,
"limit" : 10,
"total" : 2,
"reusable_jobs" : [ {
"id" : "35b54cc1cf904fa786233a1f0555a630",
"name" : "构建",
"description" : "",
"domain_id" : "0bc8d446b78010880f2fc009114e92a0",
"region" : "xxx-2",
"project_id" : "0493899d9e6644cba4583c778443fad0",
"deleted" : false,
"enabled" : true,
"creator_id" : "URdkP0HZQ3mewZYy5QOIYEJ2909KJvJA",
"updater_id" : "URdkP0HZQ3mewZYy5QOIYEJ2909KJvJA",
"creator_name" : "user1",
"updater_name" : "user1",
"create_time" : 1742784776000,
"update_time" : 1742784776000
}, {
"id" : "42a062e332474470a4d6bd9c555fa81a",
"name" : "延时执行",
"description" : "",
"domain_id" : "0bc8d446b78010880f2fc009114e92a0",
"region" : "xxx-2",
"project_id" : "0493899d9e6644cba4583c778443fad0",
"deleted" : false,
"enabled" : true,
"creator_id" : "URdkP0HZQ3mewZYy5QOIYEJ2909KJvJA",
"updater_id" : "URdkP0HZQ3mewZYy5QOIYEJ2909KJvJA",
"creator_name" : "user1",
"updater_name" : "user1",
"create_time" : 1742784260000,
"update_time" : 1742784260000
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
错误码
请参见错误码。
