You need to enable JavaScript to run this app.
导航

触发工作流

最近更新时间2024.01.09 14:56:12

首次发布时间2021.02.23 10:42:37

此接口用于指定音视频 Vid 触发工作流,完成媒体处理。

使用说明

注意事项

请求频率:单用户请求频率限制为 50 次/秒

请求说明

请求地址:https://vod.volcengineapi.com?Action=StartWorkflow&Version=2020-08-01

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数

参数类型是否必选示例值描述
ActionStringStartWorkflow接口名称。当前 API 的名称为 StartWorkflow
VersionString2020-08-01接口版本。当前 API 的版本为 2020-08-01

Vid

String

v023bbg10001***2n6qiboeb9dn73mg

音视频 ID。音视频上传后,获取的方式如下所示。

  • 通过GetMediaList接口查询音视频 Vid,为请求参数 Vid 的值。
  • 如果设置了媒资上传完成的回调事件,会在FileUploadComplete中返回 Vid 的值。
TemplateIdString63d92a1***b1795工作流模板 ID。
InputObject of Input{"OverrideParams":{"TranscodeVideo":[{"TemplateId":["1091058d048***c352ee1c52"],"OutputIndex":null,"FileName":"{{fileTitle}}"}]}}JSON 对象。
PriorityInteger0任务优先级。默认值 0。取值范围为 [-5,5]。
CallbackArgsStringYourCallbackArgs您可自定义的字段,回调时会透传返回。在处理回调消息时自己解析使用。最大长度 512 字节。

EnableLowPriority

Boolean

false

是否开启闲时转码功能。支持的取值如下:

  • true:开启。
  • false:关闭。

说明

对于闲时转码功能的介绍和使用场景,请见闲时转码

DirectUrl

Object of DirectUrl

{"FileName": "example.mp4"}

DirectUrl 模式。

说明

Vid 和 DirectUrl 参数二选一。

Input

参数类型是否必选示例值描述
OverrideParamsObject of OverrideParams{"TranscodeVideo":[{"TemplateId":["1091058d0***8f408c352ee1c52"],"OutputIndex":null,"FileName":"{{fileTitle}}"}]}用于覆盖模板中的参数。

Condition

JSON Map

{"xxxx":true}

任务执行条件和每个节点是否执行完成。格式为 "key":"value"

  • "key" 为 String 类型,任务执行条件;
  • "value" 为 Boolean 类型,判断每个节点是否执行完成。

DirectUrl

参数类型是否必选示例值描述
FileNameStringexample.mp4文件路径。
BucketNameStringYourBucketName存储桶名称。

OverrideParams

参数类型是否必选示例值描述
LogoArray of Logo[{"TemplateId":"1091058d0**6b8f408c352ee1c52","Vars":{"keyword":"hello"}}]水印内容覆盖参数。
TranscodeVideoArray of TranscodeVideo[{"TemplateId":["1091058d0**6b8f408c352ee1c52"],"Clip":{"StartTime":0,"EndTime":20000}}]视频转码内容覆盖参数。
TranscodeAudioArray of TranscodeAudio[{"TemplateId":["1091058d0**6b8f408c352ee1c52"],"Clip":{"StartTime":0,"EndTime":20000}}]音频转码内容覆盖参数。
SnapshotArray of Snapshot[{"Type":["AnimatedPoster"],"OffsetTime":0,"OffsetTimeList":null,"SampleOffsets":null}]截图模板覆盖参数。
参数类型是否必选示例值描述
TemplateIdString1091058d0**6b8f408c352ee1c52水印模板 ID。

Vars

JSON Map

{"keyword":"hello"}

水印覆盖内容。格式为 "key":"value"

  • "key" 为 String 类型,水印模板;
  • "value" 为 String 类型,水印覆盖的内容。

说明

只有水印模板上已定义的变量才支持覆盖。

TranscodeVideo

参数类型是否必选示例值描述
TemplateIdArray of String1091058d0**6b8f408c352ee1c52模板 ID 列表。支持 All 取值,此时不区分模板,只要为该类型就生效。
ClipObject of Clip{"StartTime":0,"EndTime":20000}裁剪参数。
OutputIndexArray of Integer[1,2]仅模板组生效,档位的数组下标。

FileName

String

{{fileName}}

自定义文件路径。变量取值如下:

  • {{fileName}}:文件路径。
  • {{fileTitle}}:文件名称。
  • {{filePrefix}}:文件前缀。
  • {{vid}}:片源 Vid。
  • {{templateId}}:视频转码模板 ID。
  • {{random}}:32 位随机字符串。
  • {{outFormat}}:文件格式。

说明

封装格式为 Dash 时,目前该取值不生效。

TranscodeAudio

参数类型是否必选示例值描述
TemplateIdArray of String1091058d0**6b8f408c352ee1c52模板 ID 列表。支持 All 取值,此时不区分模板,只要为该类型就生效。
ClipObject of Clip{"StartTime":0,"EndTime":20000}裁剪参数。

FileName

String

{{fileTitle}}

自定义文件路径。变量取值如下:

  • {{fileName}}:文件路径。
  • {{fileTitle}}:文件名称。
  • {{filePrefix}}:文件前缀。
  • {{vid}}:片源 Vid。
  • {{templateId}}:音频转码模板 ID。
  • {{random}}:32 位随机字符串。
  • {{outFormat}}:文件格式。

说明

封装格式为 Dash 时,目前该取值不生效。

Snapshot

参数类型是否必选示例值描述
TemplateIdArray of String1091058d0**6b8f408c352ee1c52模板 ID 列表。支持 All 取值,此时不区分模板,只要为该类型就生效。

OffsetTime

Integer

100

截图时间。选择如下截取类型,截取时间才生效。

  • Poster:静态图。
  • Dynpost:动图。
  • AnimatedPoster:反复循环动图。
OffsetTimeListArray of Integer[10,20]多动图截图时间。针对 Dynpost 类型截图模板有效。

FileName

String

{{fileTitle}}

自定义文件路径。变量取值如下:

  • {{fileName}}:文件路径。
  • {{fileTitle}}:文件名称。
  • {{filePrefix}}:文件前缀。
  • {{vid}}:片源 Vid。
  • {{templateId}}:截图模板 ID。
  • {{random}}:32 位随机字符串。
  • {{count}}:5 位数字占位符,如:00001,00002 等。如果您选择了采样截图、雪碧图,请加入该变量来区分多张截图。
  • {{outFormat}}:文件格式。

说明

封装格式为 Dash 时,目前该取值不生效。

FileIndex

String

{{fileTitle}}

支持指定截图 index 文件的自定义路径,仅采样截图生效。取值如下:

  • {{fileName}}:文件路径。
  • {{fileTitle}}:文件名称。
  • {{filePrefix}}:文件前缀。
  • {{vid}}:片源 Vid。
  • {{templateId}}:截图模板 ID。
  • {{random}}:32 位随机字符串。
SampleOffsetsArray of Float[1.0,2.0]采样截图自定义时间。针对 Sample 类型截图模板有效。

Clip

参数类型是否必选示例值描述
StartTimeInteger0开始时间,单位为 ms。
EndTimeInteger2000结束时间,单位为 ms。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数

参数类型示例值描述
RunIdStringbe:0f557116******059cedf92f1bd工作流执行 ID。

请求示例

https://vod.volcengineapi.com?Action=StartWorkflow&Version=2020-08-01&Vid=v023bbg10001***2n6qiboeb9dn73mg&TemplateId=63d92a1***b1795&&EnableLowPriority=true&DirectUrl.FileName=example.mp4&DirectUrl.BucketName=tos-cnxxx

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202208121******514515206772F7C",
    "Action": "StartWorkflow",
    "Version": "2020-08-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "RunId": "be:0f557116******059cedf92f1bd"
  }
}

错误码

下表列举了本接口特有的错误码。如需了解更多错误码,更多信息请见公共错误码

状态码错误码错误信息说明
400InvalidParameter-非法参数。
403RequestForbidden-请求被禁止。
404ResourceNotFound-ID 找不到。
409ResourceInUse-ID 正在被使用(删除时)。
429RequestLimitExceeded-请求超过上限。
500InternalError-内部错误。
503ServiceUnavailable-服务不可用。

SDK

点播 OpenAPI 提供了配套的服务端 SDK,支持多种编程语言,帮助您实现快速开发。建议使用服务端 SDK 来调用 API。此 API 各语言调用的示例代码,请参考如下: