文档中心

公共数据结构

最近更新时间：2024.02.27 15:46:53

首次发布时间：2021.10.21 21:32:31

本文为您介绍智能处理 OpenAPI 的公共数据结构。

ResponseMetadata

媒资信息的公共数据结构。

任务输入文件的公共数据结构。

参数	类型	是否必传	描述
Type	String	是	输入类型。取值如下： `VOD`：点播视频库。 `VODMaterial`：点播素材库。 `TOS`：对象存储。注意当 `Type` 取值为 `VODMaterial` 时，只能作为素材使用，不能作为处理的输入。需要注意的是在工作流模板配置输入选择类型为图片时除外。
TosBucket	String	否	对象存储桶。说明当 `Type` 取值为 `TOS` 时，该 `TosBucket` 参数才能生效。
VodSpaceName	String	否	支持选择指定的点播空间。说明当参数 `Type` 取值为 `VOD` 或者 `VODMaterial` 时，该 `VodSpaceName` 参数才能生效。
FileId	String	是	文件 ID。

任务输出文件的公共数据结构。

参数类型是否必传描述

参数	类型	是否必传	描述
Type	String	是	输出类型。取值如下： `VOD`：点播视频库。 `TOS`：对象存储。
VodSpaceName	String	否	指定的点播空间。说明当参数 `Type` 取值为 `VOD` 时，该 `VodSpaceName` 参数才能生效。
TosBucket	String	否	对象存储桶。说明当 `Type` 取值为 `TOS` 时，该 `TosBucket` 参数才能生效。

Type

String

是

输出类型。取值如下：

VodSpaceName

String

否

指定的点播空间。

说明

当参数 Type 取值为 VOD 时，该 VodSpaceName 参数才能生效。

TosBucket

String

否

对象存储桶。

说明

当 Type 取值为 TOS 时，该 TosBucket 参数才能生效。

任务输出的公共数据结构。

参数	类型	是否必传	描述
TemplateId	String	是	模板 ID。
TemplateName	String	是	模板参数。
Properties	Object	否	输出信息。详情请见任务节点输出定义。
Status	String	是	状态。取值如下： `Completed`：成功。 `Failed`：失败。 `Timeout`：超时。
ActivityId	String	是	工作流节点 ID。
StartTime	String	是	开始时间。
EndTime	String	是	结束时间。

任务执行的公共数据结构。

参数	类型	是否必传	描述
JobId	String	是	任务 ID。
InputPath	InputPath	是	任务输入地址配置。
OutputPath	OutputPath	是	任务输出地址配置。
Output	Array of JobOutput	是	任务输出详情。
Status	String	是	任务状态。状态类型如下： `Completed`：执行成功。 `Running`：执行中。 `Failed`：执行失败。 `TimedOut`：超时。 `Canceled`：取消。
CallbackArgs	String	是	回调参数。
CreatedAt	String	是	创建时间。
FinishedAt	String	是	完成时间。
EnableLowPriority	String	是	闲时任务。取值如下： `true`：开启。 `false`：（默认）关闭。
JobSource	String	是	任务来源。取值如下： `Console`：（默认）控制台。 `API`：调用 API。 `AutoTrigger`：自动触发。

ResponseMetadata

InputPath

OutputPath

JobOutput

JobExecution