文档首页/视频智能分析服务 VIAS/API参考/平台API/任务中心/获取任务列表 - ListTasks
更新时间：2025-12-18 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取任务列表 - ListTasks

功能介绍

获取任务列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/tasks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

用户项目ID，获取方法参见获取项目ID和名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

source_data_type

否

String

参数解释：

任务类型。

约束限制：

不涉及。

取值范围：

  • async_task

  • sync_task

默认取值：

不涉及。

title

否

String

参数解释：

算法中文名。

约束限制：

不涉及。

取值范围：

需要满足正则表达式^[a-zA-Z0-9\u4e00-\u9fa5-_,]{2,64}$。

默认取值：

不涉及。

camera_name

否

String

参数解释：

摄像头名称。

约束限制：

不涉及。

取值范围：

字符串长度[0, 255]。

默认取值：

不涉及。

task_state

否

String

参数解释：

任务状态。

约束限制：

不涉及。

取值范围：

  • PENDING（等待中）

  • RECOVERING（恢复中）

  • STARTING（启动中）

  • UPGRADING（升级中）

  • CREATE_FAILED（创建失败）

  • START_FAILED（启动失败）

  • RUNNING（运行中）

  • STOPPING（停止中）

  • STOPPED（已停止）

  • ABNORMAL（异常）

  • SUCCEEDED（运行成功）

  • FAILED（运行失败）

  • DELETING（删除中）

  • FREEZING（冻结中）

  • FROZEN（已冻结）

  • SCHEDULING（调度中）

默认取值：

不涉及。

task_name

否

String

参数解释：

任务名称。

约束限制：

不涉及。

取值范围：

字符串长度[0, 1024]。

默认取值：

不涉及。

page_size

否

Integer

参数解释：

每页显示的条目数量。

约束限制：

不涉及。

取值范围：

5-1000

默认取值：

10

page

否

Integer

参数解释：

偏移量。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

1

sort_dir

否

String

参数解释：

展示服务任务时的排序规则。

约束限制：

不涉及。

取值范围：

  • desc（倒序）

  • asc（正序）

默认取值：

desc

batch_id

否

String

参数解释：

批量配置ID。

约束限制：

不涉及。

取值范围：

需要满足正则表达式^[a-z0-9-_]{4,36}$。

默认取值：

不涉及。

video_group_id

否

String

参数解释：

视频分组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}$。

默认取值：

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token，获取方法参见认证鉴权。

约束限制：

不涉及。

取值范围：

字符串长度[0, 32768]。

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

count

Integer

参数解释：

当前页面的条目数。

取值范围：

不涉及。

tasks

Array of TaskInfo objects

参数解释：

查询到的任务列表信息。

取值范围：

不涉及。

page

Integer

参数解释：

当前页号。

取值范围：

不涉及。

page_size

Integer

参数解释：

分页尺寸。

取值范围：

不涉及。

表5 TaskInfo

参数

参数类型

描述

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（已冻结）

  • SCHEDULING（调度中）

video_source_name

String

参数解释：

视频源名称。

取值范围：

不涉及。

title

String

参数解释：

算法中文名称。

取值范围：

不涉及。

type

String

参数解释：

任务类型。

取值范围：

0：云上任务。

1：边缘任务。

algorithm_publish_id

String

参数解释：

算法id。

取值范围：

不涉及。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误信息描述。

取值范围：

不涉及。

detail

String

参数解释：

错误详情。

取值范围：

不涉及。

params

Array of strings

参数解释：

错误参数列举。

取值范围：

列表长度[0, 1]。

reason

String

参数解释：

错误原因。

取值范围：

不涉及。

advice

String

参数解释：

建议。

取值范围：

不涉及。

状态码：500

表7 响应Body参数

参数

参数类型

描述

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

内部错误。

父主题：任务中心

相关文档