You need to enable JavaScript to run this app.
导航
视频点播
  • 文档首页
    • /视频点播/API 参考/媒体处理/触发工作流
触发工作流
最近更新时间：2024.09.20 14:52:24首次发布时间：2021.02.23 10:42:37
我的收藏

此接口用于指定工作流 ID 来触发媒体处理任务，以对指定片源进行媒体处理。

使用说明

注意事项

  • 请求频率：单用户请求频率限制为 50 次/秒。
  • 优先级：本接口的参数设置优先级高于视频点播控制台媒体处理模板和工作流中的参数设置。

请求说明

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

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

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

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

Vid

String

否

v023bbg10001***2n6qiboeb9dn73mg

视频 ID。音视频上传至视频点播服务后，您可通过媒资上传完成事件获取 Vid。

注意

您必须设置 Vid 或 DirectUrl 参数之一，不能同时设置这两个参数。

TemplateIdString是63d92a1***b1795工作流 ID。您可在视频点播控制台工作流页面获取 TemplateId。

Input

Object of WorkflowParams

否

-

动态参数。

说明

如果是 POST 请求，该参数类型为 String。示例：
"{\"OverrideParams\":{\"Logo\":[{\"Vars\":{\"input_text\":\"文字水印测试\"}}]}}"

PriorityInteger否0任务优先级。默认值 0。取值范围为 [-5,5]。
CallbackArgsString否YourCallbackArgs您可自定义的字段，回调时会透传返回。在处理回调消息时自己解析使用。最大长度 512 字节。

EnableLowPriority

Boolean

否

false

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

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

说明

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

DirectUrl

Object of DirectUrl

否

-

DirectUrl 模式下的文件存储信息。

注意

  • 您必须设置 Vid 或 DirectUrl 参数之一，不能同时设置这两个参数。
  • 如果是 POST 请求，该参数类型为 String。示例：
    "{\"FileName\":\"example.mp4\"}"

WorkflowParams

参数类型是否必选示例值描述

Condition

JSON Map

否

{"xxxx":true}

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

  • "key"：String 类型，任务执行条件。
  • "value"：Boolean 类型，判断每个节点是否执行完成。
OverrideParamsObject of OverrideParams否-覆盖参数，用于覆盖媒体处理模板中的配置。

DirectUrl

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

OverrideParams

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

LogoOverride

参数类型是否必选示例值描述

Vars

JSON Map

否

{"keyword":"hello"}

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

  • "key"：String 类型。该值为您在视频点播控制台水印贴片模板中配置的自定义变量 key。具体步骤，请见动态替换文字水印内容。
  • "value"：String 类型。该值为自定义文字水印内容。
TemplateIdString否1091058d0**6b8f408c352ee1c52水印贴片模板 ID。支持设为 All，表示对所有水印贴片模板生效。

SnapshotOverride

参数类型是否必选示例值描述

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 位随机字符串。

OffsetTime

Integer

否

100

截图间隔。该参数仅当截图类型为以下时才生效。

  • Poster：静态图。
  • Dynpost：动图。
  • AnimatedPoster：反复循环动图。
TemplateIdArray of String否1091058d0**6b8f408c352ee1c52模板 ID 列表。支持取值为 All，表示不区分模板，只要为该类型就生效。
SampleOffsetsArray of Float否[1.0,2.0]采样截图时间点。单位为秒。针对 Sample 类型截图模板有效。
OffsetTimeListArray of Integer否[10,20]多动图截图时间。单位为毫秒。针对 Dynpost 类型截图模板有效。

TranscodeAudioOverride

参数类型是否必选示例值描述
ClipObject of Clip否{"StartTime":0,"EndTime":20000}裁剪参数。

FileName

String

否

{{fileTitle}}

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

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

注意

封装格式为 Dash 时，该参数不生效。

TemplateIdArray of String否1091058d0**6b8f408c352ee1c52模板 ID 列表。支持 All 取值，此时不区分模板，只要为该类型就生效。

TranscodeVideoOverride

参数类型是否必选示例值描述
ClipObject of Clip否{"StartTime":0,"EndTime":20000}裁剪参数。

FileName

String

否

{{fileName}}

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

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

注意

封装格式为 Dash 时，该参数不生效。

TemplateIdArray of String否1091058d0**6b8f408c352ee1c52媒体处理模板 ID 列表。支持取值为 All，表示不区分模板，只要为该类型就生效。

LogoTemplateId

String

否

1091058****6b8f408c352ee1c52

水印贴片模板 ID。

注意

该参数仅当 TemplateId 所对应的模板是视频转码或极智超清类型时生效。

Clip

参数类型是否必选示例值描述
EndTimeInteger否2000裁剪结束时间，单位为毫秒。
StartTimeInteger否0裁剪开始时间，单位为毫秒。

返回参数

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

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

请求示例

https://vod.volcengineapi.com?Action=StartWorkflow&Version=2020-08-01&TemplateId=63d92a1***b1795&EnableLowPriority=true&DirectUrl={"FileName":"input_test.mp4"}

返回示例

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

错误码

下表列举了本接口特有的错误码。如需了解更多错误码，详见视频点播公共错误码。

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

SDK

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