You need to enable JavaScript to run this app.
导航
视频点播
  • 文档首页
    • /视频点播/API 参考/媒体处理/StartExecution - 提交媒体处理任务
StartExecution - 提交媒体处理任务
最近更新时间：2025.03.11 21:22:49首次发布时间：2025.03.11 21:22:49
我的收藏
有用
有用
无用
无用

调用 StartExecution 接口提交媒体处理任务，对指定文件进行媒体处理。

注意事项

  • 该接口仅支持白名单用户调用。使用前请提交工单联系火山引擎技术支持团队申请开通。
  • 本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 QPS 限制。

请求说明

  • 请求方式：POST
  • 请求地址：https://vod.volcengineapi.com?Action=StartExecution&Version=2023-07-01

调试

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

请求参数

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

Query

参数
类型
是否必选
示例值
描述
Action
String
是
StartExecution
接口名称。当前 API 的名称为 StartExecution。
Version
String
是
2023-07-01
接口版本。当前 API 的版本为 2023-07-01。

Body

参数
类型
是否必选
示例值
描述
Input
Object
是
-
输入文件信息。
Type
String
是
Vid

输入文件类型。取值如下：

  • Vid：Vid 模式。此模式下，您还需设置 Vid 参数。

  • DirectUrl：DirectUrl 模式。此模式下，您还需设置 DirectUrl 参数。

Vid
String
否
v0ccfeg7007acsgvd8fog65ubr7niqng

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

注意

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

DirectUrl
Object
否
-

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

注意

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

SpaceName
String
是
test
空间名称。可调用 ListSpace 获取当前账号下所有空间的信息。
FileName
String
是
example.mp4
文件路径。音视频上传至视频点播服务后，您可通过媒资上传完成事件获取 FileName。
BucketName
String
否
tos-cn-v-cd3a11
存储桶名称。可调用 ListSpace 获取空间所绑定的存储桶名称。
Operation
Object
是
-
媒体处理操作配置。
Type
String
是
Task
处理类型。当前仅支持 Task（单任务）。
Task
Object
否
-
任务配置。当 Type 为 Task 时需要设置此参数。
Type
String
是
Highlight
任务类型。当前仅支持设为 Highlight（高光分析任务）。
Highlight
Object
否
-
高光分析任务配置。当 Type 为 Highlight 时需要设置此参数。当前为预留参数，暂不生效，可传入空对象。
Control
Object
否
-
任务控制配置。
ClientToken
String
否
QqS3o5L4BLFCDxGZ&b
用户请求凭证，用于区分不同请求。大小写敏感，不超过 64 个 ASCII 码可打印字符。默认情况下，视频点播转码服务在接收到触发工作流请求后，会执行幂等行为。这意味着，如果判定当前请求与之前发送的请求相同，则不会重复执行该请求。关于幂等行为、目的和条件，请参考工作流幂等说明。若您希望跳过幂等行为，例如修改了某一工作流所绑定的媒体处理模板中的配置，想要对同一个 Vid 重新执行相同的工作流，则可以设置此参数。
CallbackArgs
String
否
Example
自定义字段，将在媒体处理任务执行完成事件中透传返回。字段长度最大为 512 字节。

返回参数

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

参数
类型
示例值
描述
RunId
String
hb:c5cacd4946bd***a5fd9f74159b03ae8
媒体处理任务执行 ID。

请求示例

以下示例展示如何通过 Vid 提交高光分析任务：

POST https://vod.volcengineapi.com?Action=StartExecution&Version=2023-07-01
{
  "Input": {
    "Type": "Vid",
    "Vid": "v0ccfeg7007acsg***fog65ubr7niqng"
  },
  "Operation": {
    "Type": "Task",
    "Task": {
      "Type": "Highlight",
      "Highlight": {}
    }
  },
  "Control": {
    "ClientToken": "1234567891012345678901234"
  }
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230604110420****100232280022D31",
    "Action": "StartExecution",
    "Version": "2023-07-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "RunId": "hb:c5cacd4946bd***a5fd9f74159b03ae8"
  }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。