获取批量配置任务列表 - ListBatchTasks
功能介绍
获取批量配置任务列表。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/batch-tasks
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 参数解释: 用户项目ID,获取方法参见获取项目ID和名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
is_paged | 否 | Boolean | 参数解释: 是否分页。 约束限制: 不涉及。 取值范围:
默认取值: true |
page_size | 否 | Integer | 参数解释: 每页显示的条目数量。 约束限制: 不涉及。 取值范围: 5-200 默认取值: 10 |
page_num | 否 | Integer | 参数解释: 页号。 约束限制: 不涉及。 取值范围: 1-10000 默认取值: 1 |
order_by | 否 | String | 参数解释: 排序方式。 约束限制: 不涉及。 取值范围:
默认取值: desc |
sort_name | 否 | String | 参数解释: 排序字段。 约束限制: 不涉及。 取值范围:
默认取值: created_at |
video_group | 否 | String | 参数解释: 视频源分组列表。 约束限制: 不涉及。 取值范围: 多个以逗号分隔,需要满足正则:^[a-zA-Z0-9\u4e00-\u9fa5,-_]{1,1000}$。 默认取值: 不涉及。 |
task_state | 否 | String | 参数解释: 任务状态。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
type_like | 否 | String | 参数解释: 模糊查询字段。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
name_like | 否 | String | 参数解释: 模糊查询名称,需要与type_like搭配使用来实现是通过batch_task_name还是publish_service_name进行模糊查询。 约束限制: 不涉及。 取值范围: 字符串长度[0, 100]。 默认取值: 不涉及。 |
manufacturer | 否 | String | 参数解释: 根据厂商字段筛选。 约束限制: 不涉及。 取值范围: 需要满足正则表达式 ^[a-zA-Z0-9\u4e00-\u9fa5,-_]{2,64}$。 默认取值: 不涉及。 |
title | 否 | String | 参数解释: 算法中文名。 约束限制: 不涉及。 取值范围: 需要满足正则表达式 ^[a-zA-Z0-9\u4e00-\u9fa5,-_]{2,64}$。 默认取值: 不涉及。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 参数解释: 用户Token,获取方法参见认证鉴权。 约束限制: 不涉及。 取值范围: 字符串长度[0, 32768]。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
count | Integer | 参数解释: 条目总数。 取值范围: 不涉及。 |
batch_task_list | Array of BatchTaskDto objects | 参数解释: 批量作业列表。 取值范围: 不涉及。 |
参数 | 参数类型 | 描述 |
|---|---|---|
id | String | 参数解释: 批量作业ID。 取值范围: 不涉及。 |
batch_task_name | String | 参数解释: 批量作业名称。 取值范围: 不涉及。 |
video_source_name | String | 参数解释: 视频源名称。 取值范围: 不涉及。 |
video_group_name | String | 参数解释: 分组名称。 取值范围: 不涉及。 |
alg_name | String | 参数解释: 算法名称。 取值范围: 不涉及。 |
company | String | 参数解释: 厂商名。 取值范围: 不涉及。 |
type | String | 参数解释: 作业类型。 取值范围: 不涉及。 |
num_task | Integer | 参数解释: 批量作业总数。 取值范围: 不涉及。 |
created_at | Long | 参数解释: 创建时间。 取值范围: 不涉及。 |
batch_task_status_info | BatchTaskStatusInfoDto object | 参数解释: 批量作业状态基本信息。 取值范围: 不涉及。 |
参数 | 参数类型 | 描述 |
|---|---|---|
pending | Integer | 参数解释: 等待中作业数量。 取值范围: 不涉及。 |
recovering | Integer | 参数解释: 恢复中作业数量。 取值范围: 不涉及。 |
starting | Integer | 参数解释: 启动中作业数量。 取值范围: 不涉及。 |
upgrading | Integer | 参数解释: 升级中作业数量。 取值范围: 不涉及。 |
create_failed | Integer | 参数解释: 创建失败作业数量。 取值范围: 不涉及。 |
start_failed | Integer | 参数解释: 启动失败作业数量。 取值范围: 不涉及。 |
running | Integer | 参数解释: 运行中作业数量。 取值范围: 不涉及。 |
stopping | Integer | 参数解释: 停止中作业数量。 取值范围: 不涉及。 |
stopped | Integer | 参数解释: 已停止作业数量。 取值范围: 不涉及。 |
abnormal | Integer | 参数解释: 异常作业数量。 取值范围: 不涉及。 |
succeeded | Integer | 参数解释: 运行成功作业数量。 取值范围: 不涉及。 |
failed | Integer | 参数解释: 运行失败作业数量。 取值范围: 不涉及。 |
deleting | Integer | 参数解释: 删除中作业数量。 取值范围: 不涉及。 |
freezing | Integer | 参数解释: 冻结中作业数量。 取值范围: 不涉及。 |
frozen | Integer | 参数解释: 已冻结作业数量。 取值范围: 不涉及。 |
stopped_no_service | Integer | 参数解释: 无服务的任务数量。 取值范围: 不涉及。 |
scheduling | Integer | 参数解释: 调度中。 取值范围: 不涉及。 |
lack_of_resources | Integer | 参数解释: 资源不足,创建失败。 取值范围: 不涉及。 |
状态码:400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
error_msg | String | 参数解释: 错误信息描述。 取值范围: 不涉及。 |
detail | String | 参数解释: 错误详情。 取值范围: 不涉及。 |
params | Array of strings | 参数解释: 错误参数列举。 取值范围: 列表长度[0, 1]。 |
reason | String | 参数解释: 错误原因。 取值范围: 不涉及。 |
advice | String | 参数解释: 建议。 取值范围: 不涉及。 |
状态码:500
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
error_msg | String | 参数解释: 错误信息描述。 取值范围: 不涉及。 |
detail | String | 参数解释: 错误详情。 取值范围: 不涉及。 |
params | Array of strings | 参数解释: 错误参数列举。 取值范围: 列表长度[0, 1]。 |
reason | String | 参数解释: 错误原因。 取值范围: 不涉及。 |
advice | String | 参数解释: 建议。 取值范围: 不涉及。 |
请求示例
获取批量配置任务列表,展示批量配置名称,视频源分组,算法服务名称,配置类型,配置任务数量,创建时间,配置下任务状态。
https://xxx/v2/xxx/batch-tasks?page_num=1&page_size=10
响应示例
状态码:200
批量操作响应体。
{
"count" : 2,
"batch_task_list" : [ {
"id" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"batch_task_name" : "qqqq",
"video_group_name" : "2312,1889,927,914",
"alg_name" : "testwjh",
"type" : "0",
"num_task" : 3,
"created_at" : 1685667905165,
"batch_task_status_info" : {
"stopped" : 3
}
}, {
"id" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"batch_task_name" : "qqq",
"video_group_name" : "2312",
"alg_name" : "testwjh",
"type" : "0",
"num_task" : 1,
"created_at" : 1685667856283,
"batch_task_status_info" : {
"running" : 1
}
} ]
} 状态码
状态码 | 描述 |
|---|---|
200 | 批量操作响应体。 |
400 | 请求错误。 |
500 | 内部错误。 |

