获取任务详情 - ShowTaskInfo

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

task_id

是

String

参数解释：

作业ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

字符串长度[0, 32768]。

默认取值：

不涉及。

id

String

参数解释：

任务ID。

取值范围：

不涉及。

name

String

参数解释：

任务的名称。

取值范围：

不涉及。

creator

String

参数解释：

任务创建者的用户名。

取值范围：

不涉及。

project_id

String

参数解释：

任务创建者的项目ID。

取值范围：

不涉及。

description

String

参数解释：

任务的描述。

取值范围：

字符串长度[0, 500]。

release_id

String

参数解释：

任务对应服务的ID。

取值范围：

不涉及。

service_id

String

参数解释：

任务对应服务的ID。

取值范围：

不涉及。

created_at

String

参数解释：

任务创建的时间。

取值范围：

不涉及。

updated_at

String

参数解释：

任务最近一次状态更新的时间。

取值范围：

不涉及。

state

String

参数解释：

任务状态。

取值范围：

• PENDING（等待中）

• RECOVERING（恢复中）

• STARTING（启动中）

• UPGRADING（升级中）

• CREATE_FAILED（创建失败）

• START_FAILED（启动失败）

• RUNNING（运行中）

• STOPPING（停止中）

• STOPPED（已停止）

• ABNORMAL（异常）

• SUCCEEDED（运行成功）

• FAILED（运行失败）

• DELETING（删除中）

• FREEZING（冻结中）

• FROZEN（已冻结）

• SCHEDULING（调度中）

status

String

参数解释：

任务状态的详情信息，仅部分状态会有详情信息。

取值范围：

字符串长度[0, 4096]。

error

error object

参数解释：

错误信息。

取值范围：

不涉及。

schedule_status

String

参数解释：

计划任务的状态。

取值范围：

• ACTIVATED（激活）

• INACTIVATED（未激活）

schedule

TaskSchedule object

定时任务参数，定时周期 仅支持周模式。

input

TaskInput object

任务的输入配置，必填。

output

TaskOutputForDisplay object

作业的输出配置展示。

config

TaskServiceConfig object

任务运行时指定的自定义参数，由服务发布者定义。

video_source_name

String

参数解释：

视频源名称。

取值范围：

不涉及。

title

String

参数解释：

算法中文名称。

取值范围：

不涉及。

group_name

String

参数解释：

分组名称，多个以逗号分隔。

取值范围：

不涉及。

company

String

参数解释：

厂商。

取值范围：

不涉及。

task_config

String

参数解释：

任务算法配置。

取值范围：

不涉及。

type

String

参数解释：

cloud或edge。

取值范围：

不涉及。

resource_order_id

String

参数解释：

资源订单id。

取值范围：

不涉及。

package_id

String

参数解释：

算法包id。

取值范围：

不涉及。

device_id

String

参数解释：

设备id。

取值范围：

不涉及。

access_address

String

参数解释：

接入地址。

取值范围：

不涉及。

algorithm_publish_id

String

参数解释：

算法id。

取值范围：

不涉及。

code

String

错误码。

message

String

错误描述。

type

String

参数解释：

计划任务的类型，使用计划任务时必填。可选类型weekly（每周执行）。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

timezone

String

参数解释：

用户所处的时区，使用计划任务时必填。精确到分钟。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

days_of_week

Array of integers

参数解释：

任务会在一周的哪几天执行，当且仅当计划任务类型为weekly时，该字段需填且必填。1~7分别指代星期一至星期日。

约束限制：

不涉及。

取值范围：

列表长度[1, 7]。

默认取值：

不涉及。

days_of_month

Array of integers

参数解释：

任务会在一个月的哪几天执行，当且仅当计划任务类型为monthly时，该字段需填且必填。1~31分别指代一个月中的1日至31日，当前系统不支持该参数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

periods

Array<Array<TimeWindow>>

参数解释：

时间段模式配置，指定周计划或者月计划中具体每天作业的执行时间段，至少需指定一个时间段。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

begin_at

String

参数解释：

单个时间段执行的起始时间，必填。其余计划任务类型时，格式为hh:mm:ss。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

end_at

String

参数解释：

单个时间段执行的结束时间，必填，其余计划任务类型时，格式为hh:mm:ss。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

type

String

参数解释：

任务的输入类型，创建时必填，视频源类型为video_source 时 不支持切换为其他的type。创建时可选类型有

obs（对象存储服务存储的文件 仅云上任务支持，支持输出到webhook），

url（指定的文件地址或取流地址 仅云上任务支持，支持输出到webhook），

edgecamera（绑定在IEF的边缘摄像头 仅边缘任务支持，支持输出到webhook）,

restful（从自定义的流媒体服务器通过Restful接口获取取流地址 云上和边缘任务均支持，支持输出到webhook），

vcn（VCN设备 仅边缘任务支持）,

video_source（使用VIAS平台视频中心管理的视频源，云上和边缘任务均支持），

建议使用video_source类型，其他类型为了兼容老业务，后续将废弃。

约束限制：

不涉及。

取值范围：

• video_source

• obs (不建议使用，后续废弃)

• url (不建议使用，后续废弃)

• edgecamera (不建议使用，后续废弃)

• restful (不建议使用，后续废弃)

• vcn (不建议使用，后续废弃)

默认取值：

不涉及。

data

Array of TaskInputData objects

参数解释：

任务的输入详情，必填。针对不同的输入类型有不同的配置。创建时允许填写多路输入，但更新时只允许填写一路输入。

当输入类型为：obs，需要配置 bucket，path ， index 。例如： "bucket": "aicam", "path": "3rdpartylicenses.txt", "index": 0

当输入类型为：url，需要配置 url， index 。例如： "url": "https://xxx-xxx.com", "index": 0

当输入类型为：restful，需要配置 certificate_check， rtsp_path_in_response， url， index， headers 。例如："certificate_check": true, "url": "https://hsaij-dasahbi.com", "rtsp_path_in_response": "data/url", "index": 0, "headers": { "AAA": "AAA" }

当输入类型为：vcn，需要配置 device_id， stream_type， index。例如："device_id": "21356478954612546874#gdhjkiushdgdksjhslmhscjsckjhdbnk", "stream_type": 1, "index": 0

当输入类型为：EdgeCamera，需要配置 id， index 例如："id": "007cdafc-6000-47ce-b0e3-870b4a0db65e","index": 0

约束限制：

不涉及。

取值范围：

列表长度[1, 50]。

默认取值：

不涉及。

vcn

TaskInputVcn object

VCN服务器信息，仅输入类型为vcn时需填且必填。

video_source_id

String

参数解释：

视频源id,当输入类型为video_source时必填。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

stream_name

String

参数解释：

视频流名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

bucket

String

参数解释：

OBS桶名，当输入为obs类型时必填。

约束限制：

不涉及。

取值范围：

字符串长度[0, 64]。

默认取值：

不涉及。

path

String

参数解释：

OBS的路径，当输入为obs类型时必填。

约束限制：

不涉及。

取值范围：

字符串长度[0, 1023]。

默认取值：

不涉及。

url

String

参数解释：

url输入源的地址或者获取视频流地址的restful请求地址，当输入为url类型或者restful类型时必填。

约束限制：

不涉及。

取值范围：

字符串长度[0, 1000]。

默认取值：

不涉及。

headers

Object

参数解释：

获取视频流地址的restful请求携带的请求头，当输入为restful类型时可选。整体呈json格式，以键值对的形式表示请求头和取值，最多允许10组。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

rtsp_path_in_response

String

参数解释：

restful请求返回的body中，视频流地址的路径，当输入为restful类型时必填。

约束限制：

不涉及。

取值范围：

字符串长度[0, 1024]。

默认取值：

不涉及。

device_id

String

参数解释：

VCN设备ID，当输入为vcn类型时必填。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

stream_type

Integer

参数解释：

准备进行分析的码流。

约束限制：

不涉及。

取值范围：

1~3，其中1代表主码流，2代表子码流1，3代表子码流2。

默认取值：

不涉及。

id

String

参数解释：

IEF挂载的边缘设备的ID，当输入为edgecamera类型时必填。

约束限制：

不涉及。

取值范围：

字符串长度[0, 63]。

默认取值：

不涉及。

certificate_check

Boolean

参数解释：

是否需要对https请求进行证书校验，当输入为restful类型时必填。取值为true或者false。

约束限制：

不涉及。

取值范围：

• true：对https请求进行证书校验

• false：不对https请求进行证书校验

默认取值：

false

ip

String

参数解释：

VCN服务器的IP地址，仅输入类型为vcn时需填且必填。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

port

Integer

参数解释：

VCN服务器的端口号，仅输入类型为vcn时需填且必填。

约束限制：

不涉及。

取值范围：

0-65535

默认取值：

不涉及。

username

String

参数解释：

VCN服务器的账号名，仅输入类型为vcn时需填且必填。

约束限制：

不涉及。

取值范围：

需要满足正则表达式^.{1,100}$。

默认取值：

不涉及。

password

String

参数解释：

VCN服务器的与账号对应的密码，仅输入类型为vcn时需填且必填。

约束限制：

不涉及。

取值范围：

需要满足正则表达式^.{1,1000}$。

默认取值：

不涉及。

obs

TaskOutputObs object

输出为obs类型时的配置信息。

dis

TaskOutputDis object

输出为dis类型时的配置信息。

webhook

TaskOutputWebhook object

输出为webhook类型时的配置信息。

event_center

Boolean

参数解释：

输出类型是否关联事件中心。

取值范围：

• true：输出方式是事件中心

• false：输出方式不是事件中心

bucket

String

参数解释：

OBS桶名，选用obs类型输出时必填。

约束限制：

不涉及。

取值范围：

需要满足正则表达式^[a-z0-9](?!.[-.][-.].)([a-z0-9-.]{1,61})[a-z0-9]$。

默认取值：

不涉及。

path

String

参数解释：

OBS的路径，选用obs类型输出时必填.

约束限制：

不涉及。

取值范围：

需要满足正则表达式 ^(?![/.\s])(?!.//.)([^:*?"<>|\]{0,1023})(?<![.\s])$。

默认取值：

不涉及。

data_category

Array of strings

参数解释：

作业输出数据类别的列表，选填，仅部分服务需要。当输出类型下有这个列表时，表示希望这个输出类型下存放dataCategory列表内的数据。

约束限制：

不涉及。

取值范围：

列表长度[0, 10]。

默认取值：

不涉及。

stream_name

String

参数解释：

DIS流名称，选用dis类型输出时必填。

约束限制：

不涉及。

取值范围：

需要满足正则表达式^[-A-Za-z0-9_]{1,64}$。

默认取值：

不涉及。

data_category

Array of strings

参数解释：

任务输出数据类别的列表，选填，仅部分服务需要。当输出类型下有这个列表时，表示希望这个输出类型下存放dataCategory列表内的数据。

【例如创建边缘人脸任务API中，输出结果支持data_category参数，取值范围为[FacaImage,OriginImage],分别表示是否发送人脸图和原始图】

约束限制：

不涉及。

取值范围：

列表长度[0, 10]。

默认取值：

不涉及。

url

String

参数解释：

结果回调地址，选用webhook类型输出时必填。

约束限制：

不涉及。

取值范围：

字符串长度[0, 1000]。

默认取值：

不涉及。

headers

Object

参数解释：

结果回调时需要携带的请求头，选用webhook类型输出时必填。

约束限制：

不涉及。

取值范围：

json格式，以键值对的形式表示请求头和取值，至少1组，至多10组。

默认取值：

不涉及。

data_category

Array of strings

参数解释：

任务输出数据类别的列表，选填，仅部分服务需要。当输出类型下有这个列表时，表示希望这个输出类型下存放dataCategory列表内的数据。

约束限制：

不涉及。

取值范围：

列表长度[0, 10]。

默认取值：

不涉及。

common

Object

参数解释：

任务运行时指定的具体的自定义配置项，由服务发布者定义。整体呈json格式，具体配置项参见相应算法服务的说明。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误信息描述。

取值范围：

不涉及。

detail

String

参数解释：

错误详情。

取值范围：

不涉及。

params

Array of strings

参数解释：

错误参数列举。

取值范围：

列表长度[0, 1]。

reason

String

参数解释：

错误原因。

取值范围：

不涉及。

advice

String

参数解释：

建议。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误信息描述。

取值范围：

不涉及。

detail

String

参数解释：

错误详情。

取值范围：

不涉及。

params

Array of strings

参数解释：

错误参数列举。

取值范围：

列表长度[0, 1]。

reason

String

参数解释：

错误原因。

取值范围：

不涉及。

advice

String

参数解释：

建议。

取值范围：

不涉及。

200

任务详情信息。

400

请求错误。

500

内部错误。