获取任务列表
功能介绍
获取任务列表
URI
GET /v2/{project_id}/tasks
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
用户项目ID，获取方法参见获取项目ID和名称 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
source_data_type |
否 |
String |
任务类型，用作查询过滤。仅支持async_task与sync_task两种类型。 |
|
title |
否 |
String |
算法中文名,需要满足正则表达式^[a-zA-Z0-9\u4e00-\u9fa5-_,]{2,64}$ |
|
camera_name |
否 |
String |
摄像头名称 最大长度：255 |
|
task_state |
否 |
String |
任务状态,状态可选PENDING|RECOVERING|STARTING|UPGRADING|CREATE_FAILED|START_FAILED|RUNNING|STOPPING|STOPPED|ABNORMAL|SUCCEEDED|FAILED|DELETING|FREEZING|FROZEN|SCHEDULING|LACK_OF_RESOURCES |
|
task_name |
否 |
String |
任务名称 最大长度：1024 |
|
page_size |
否 |
Integer |
每页显示的条目数量 最小值：5 最大值：1000 缺省值：10 |
|
page |
否 |
Integer |
偏移量 缺省值：1 |
|
sort_dir |
否 |
String |
展示服务任务时的排序规则 缺省值：desc |
|
batch_id |
否 |
String |
批量配置ID，需要满足正则表达式^[a-z0-9-_]{4,36}$ |
|
video_group_id |
否 |
String |
视频分组ID（多个ID英文逗号分隔拼接）,长度要求[4,2048] |
|
company |
否 |
String |
厂商（多选时逗号分隔拼接） |
|
alg_id |
否 |
String |
算法ID，需要满足正则表达式^[0-9a-f]{8}-[0-9a-f]{4}-[4][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$ |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token，获取方法参见认证鉴权 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Integer |
当前页面的条目数 |
|
tasks |
Array of TaskInfo objects |
查询到的任务列表信息 |
|
page |
Integer |
当前页号 |
|
page_size |
Integer |
分页尺寸 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
任务ID |
|
name |
String |
任务的名称 |
|
service_id |
String |
任务对应服务的ID |
|
created_at |
String |
任务创建的时间 |
|
state |
String |
任务当前的状态，分别为PENDING（等待中），RECOVERING（恢复中），STARTING（启动中），UPGRADING（升级中），CREATE_FAILED（创建失败），START_FAILED（启动失败），RUNNING（运行中），STOPPING（停止中），STOPPED（已停止），ABNORMAL（异常），SUCCEEDED（运行成功），FAILED（运行失败），DELETING（删除中），FREEZING（冻结中），FROZEN（已冻结） |
|
video_source_name |
String |
视频源名称 |
|
title |
String |
算法中文名称 |
|
type |
String |
任务类型（0：云上任务 1：边缘任务） |
|
algorithm_publish_id |
String |
算法id |
状态码： 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 |
建议 |
请求示例
获取任务列表，展示出状态为“运行中”，“运行成功”，“已停止”，“等待中”，“运行失败”或者“异常”的任务
/v2/{project_id}/tasks
https://{endpoint}/v2/{project_id}/tasks?page=1&page_size=10
响应示例
状态码： 200
查询作业列表响应体
{
"count" : 2,
"tasks" : [ {
"id" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"name" : "qqqq_task",
"service_id" : "xxxxxxx-xxxxxxx-xxxxxxx-xxxxx-xxxxxx",
"created_at" : "1686034773024",
"state" : "PENDING",
"video_source_name" : "url_test",
"title" : "testwjh",
"type" : "0",
"algorithm_publish_id" : "xxxxxxx-xxxxxxx-xxxxxxx-xxxxx-xxxxxx"
}, {
"id" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"name" : "task_test1",
"service_id" : "xxxxxxx-xxxxxxx-xxxxxxx-xxxxx-xxxxxx",
"created_at" : "1686027880205",
"state" : "STOPPED",
"video_source_name" : "test_g11",
"title" : "alg_test",
"type" : "0",
"algorithm_publish_id" : "xxxxxxx-xxxxxxx-xxxxxxx-xxxxx-xxxxxx"
} ],
"page" : 1,
"page_size" : 10
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询作业列表响应体 |
|
400 |
请求错误 |
|
500 |
内部错误 |
错误码
请参见错误码。
