更新时间:2023-04-24 GMT+08:00
分享

查询作业列表

功能介绍

查询当前部署下所有作业,返回详情列表。

URI

GET /v3/{project_id}/ai-mgr/deployments/{deployment_id}/tasks

表1 路径参数

参数

是否必选

参数类型

描述

deployment_id

String

部署ID,从专业版HiLens控制台部署管理获取部署列表获取

project_id

String

项目ID。获取方法请参见获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

查询的起始位置,取值范围为非负整数,默认为0

limit

Integer

每页显示的条目数量,取值范围1~100,默认为100

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

租户Token。获取方法请参见获取Token

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

count

Integer

作业数量

tasks

Array of TaskInfo objects

作业详情

表5 TaskInfo

参数

参数类型

描述

name

String

作业名称

timestamp

String

作业创建时间

description

String

作业描述

streams

Array of TaskStream objects

作业流详情

ok_pod_number

Integer

在实例上运行成功的作业数

cur_pod_number

Integer

在实例上正在运行的作业数

sum_pod_number

Integer

在实例上运行过的作业总数

fail_pod_number

Integer

在实例上运行失败的作业数

pending_pod_number

Integer

在实例上等待运行的作业数

task_status

Array of TaskStatus objects

作业状态信息

task_id

String

作业id

user_task_id

String

用户作业id

start_time_info

StartTimeInfo object

任务启动时间信息

source_usage_estimate

TaskSourceUsageEstimate object

资源消耗预估

表6 TaskStream

参数

参数类型

描述

common

Object

作业参数配置

input

TaskInput object

输入详情

outputs

Array of TaskOutputs objects

输出详情

表7 TaskInput

参数

参数类型

描述

data

Object

输入数据

type

String

输入类型

表8 TaskOutputs

参数

参数类型

描述

data

Object

输出数据

type

String

输出类型

表9 TaskStatus

参数

参数类型

描述

cause

String

作业运行失败原因

pod_id

String

实例id

pod_name

String

实例名称

task_status

String

作业在实例上的状态

表10 StartTimeInfo

参数

参数类型

描述

start_time

String

任务启动时间

frequency

String

任务运行频率(定时任务频率,每天运行还是单次运行)

mode

String

任务运行模式(按时间段运行还是按频率运行)

day_time_frame

Array of TimeFrame objects

每天运行时间段

single_time_frame

Array of TimeFrame objects

每次运行时间段

表11 TimeFrame

参数

参数类型

描述

start

String

任务开始时间

stop

String

任务结束时间

表12 TaskSourceUsageEstimate

参数

参数类型

描述

cpu

Float

cpu消耗

memory

Integer

内存消耗

请求示例

获取某个部署下所有作业详情列表

GET https://{endpoint}/v3/{project_id}/ai-mgr/deployments/{deployment_id}/tasks

Request Header:  Content-Type: application/jsonX-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...

响应示例

状态码: 200

请求成功

{
    "count": 1,
    "tasks": [
        {
            "name": "string",
            "timestamp": "string",
            "description": null,
            "streams": [
                {
                    "common": null,
                    "input": {
                        "type": "camera",
                        "data": {
                            "name": "string",
                            "create_time": "string",
                            "tag": [
                                {
                                    "config_type": "string"
                                }
                            ],
                            "id": "string",
                            "rtsp": "string"
                        },
                        "template": false
                    },
                    "outputs": [
                        {
                            "type": "dis",
                            "data": {
                                "projectId": "string",
                                "streamId": "string",
                                "streamName": "string"
                            },
                            "template": false
                        }
                    ]
                }
            ],
            "ok_pod_number": 0,
            "cur_pod_number": 0,
            "sum_pod_number": 1,
            "fail_pod_number": 1,
            "pending_pod_number": 0,
            "task_status": [
                {
                    "pod_id": "string",
                    "pod_name": "string",
                    "task_status": "string"
                }
            ],
            "task_id": "string",
            "user_task_id": null,
        }
    ]
}

状态码

状态码

描述

200

请求成功

401

认证不通过

403

拒绝执行请求

404

请求的资源不存在

500

服务器内部错误

错误码

请参见错误码

相关文档