提交媒体处理任务--智能处理-火山引擎

文档中心

立即注册

导航

提交媒体处理任务

最近更新时间：2024.11.28 18:06:40首次发布时间：2021.10.21 21:32:31

此接口用于提交单个媒体处理任务。

请求说明

请求地址：https://open.volcengineapi.com/?Action=SubmitJob&Version=2021-06-11

请求参数

参数	类型	是否必传	描述
Action	String	是	接口名称。当前接口取值为 `SubmitJob`。
Version	String	是	接口版本。当前接口取值为 `2021-06-11`。
InputPath	String	是	任务输入文件。JSON 对象，详见 InputPath。
TemplateId	String	是	工作流模板 ID。您可以登录智能处理控制台，在工作流模板页面获取所需的 `TemplateId` 。
EnableLowPriority	String	否	是否开启闲时任务。取值如下： `true`：开启 `false`：（默认）关闭
Params	String	否	任务执行参数。JSON 对象，具体参数详见 WorkflowParams。
CallbackArgs	String	否	您可自定义的字段，回调时会透传返回。在处理回调消息时自己解析使用。最大长度 512 字节。
CallbackUri	String	否	回调地址，输入限制：长度小于等于 200 仅支持 http(s) 若 ContentType 不为空则必传说明白名单能力，如需要请联系商务同学开通
CallbackContentType	String	否	任务回调数据类型，取值如下： application/octet-stream：二进制流数据，默认值 application/json：JSON 数据类型说明白名单能力，如需要请联系商务同学开通
Job	Job	否	单任务触发参数说明白名单能力，如需要请联系商务同学开通
OutputPath	OutputPath	否	输出文件路径，单任务触发时生效。说明白名单能力，如需要请联系商务同学开通

WorkflowParams

参数	类型	是否必传	描述
OverrideParams	OverrideParams	否	动态参数。

OverrideParams

参数	类型	是否必传	描述
SmartErase	Array of SmartEraseOverrideParams	否	精细化擦除动态参数。
Output	Array of OutputOverrideParams	否	输出节点动态参数。

SmartEraseOverrideParams

参数	类型	是否必传	描述
ActivityId	Array of String	是	动态参数替换的任务 ActivityId。您可以登录智能处理控制台，在工作流模板页面选中所需的 `TemplateId` 中查看工作流模板，在精细化擦除节点的弹框中获取节点名称对应 ID 即为所需的 `ActivityId`。示例为 `SmartErase_ayehvol_dgl5s4pg5k` 说明如果该参数 `ActivityId` 设置为 `*` 表示所有精细化擦除任务设置均被替换。
Watermark	Watermark	否	水印擦除动态参数。
OCR	OCR	否	字幕擦除动态参数。

Watermark

参数	类型	是否必传	描述
DetectRect	Array of DetectRect	否	水印擦除区域，最大 5 个。

OCR

参数	类型	是否必传	描述
DetectRect	Array of DetectRect	否	字幕擦除区域，最大 5 个。

DetectRect

参数	类型	是否必传	描述
X1	Float	否	左上角 x 点归一化坐标，取值范围为 [0,1]。
X2	Float	否	右下角 x 点归一化坐标，取值范围为 [0,1]。
Y1	Float	否	左上角 y 点归一化坐标，取值范围为 [0,1]。
Y2	Float	否	右下角 y 点归一化坐标，取值范围为 [0,1]。

OutputOverrideParams

参数	类型	是否必传	描述
ActivityId	Array of String	是	动态参数替换的任务 ActivityId。您可以登录智能处理控制台，在工作流模板页面选中所需的 `TemplateId` 中查看工作流模板，在输出节点的弹框中获取节点名称对应 ID 即为所需的 `ActivityId`。示例为 Output_ayehvol_dgl5s4pg5k 说明如果该参数 `ActivityId` 设置为 `*` 表示所有输出任务设置均被替换。
OutputPath	OutputPath	否	输出文件路径。

返回参数

参数	类型	描述
ResponseMetadata	ResponseMetadata	响应通用信息
Result	String	响应结果，即任务 ID。

请求示例

https://open.volcengineapi.com/?Action=SubmitJob&Version=2021-06-11&InputPath={"VodSpaceName":"space","Type":"VOD","FileId":"v0cdfeg7007aclb06u3***2ndju0"}&TemplateId=a11dccd077604bfa***39021ab2488&Params={"OverrideParams":{"SmartErase":[{"ActivityId":["*"],"Watermark":{"DetectRect":[{"X1":0,"Y1":0,"X2":0.1,"Y2":0.2}]},"OCR":{"DetectRect":[{"X1":0,"Y1":0,"X2":0.5,"Y2":0.6}]}}]}}&EnableLowPriority=false

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20221008185***451520431D9AA",
        "Action": "SubmitJob",
        "Version": "2021-06-11",
        "Service": "imp",
        "Region": "cn-north-1"
    },
    "Result": "60fb16f2c196***8c99e728dedd0b"
}

错误码

智能媒体处理公共错误码，详见公共错误码。

服务端 SDK

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