首页 智能媒体服务 开发参考 API参考 API目录 工作流 StartWorkflow - 提交工作流任务

StartWorkflow - 提交工作流任务

更新时间: 2024-12-16 10:48:58

通过调用StartWorkflow接口,您可以提交工作流模板任务,从而实现基于工作流模板的自动化媒体处理流程。

接口说明

  • 目前只支持智能媒体服务媒资/视频点播媒资作为工作流输入。
  • 发起工作流任务时,需指定工作流模板,可通过智能媒体服务控制台创建工作流模板,或使用系统预置的工作流模板。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ice:StartWorkflowcreate
*全部资源
*

请求参数

名称类型必填描述示例值
WorkflowIdstring

工作流模板 ID。您可通过智能媒体服务控制台> 配置管理 > 工作流模板,查看模板 ID。

******f0e54971ecbffd472190******
TaskInputstring

工作流输入,目前仅支持媒资类型。

{ "Type": "Media", "Media": "******30706071edbfe290b488******" }
UserDatastring

自定义设置,Json 格式,长度限制为 512 字节。支持自定义回调地址配置

{"NotifyAddress":"https://xx.xx.xxx"}或{"NotifyAddress":"ice-callback-demo"}

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

******42-E8E1-4FBB-8E52-F4225C******
TaskIdstring

工作流任务 ID。

******22dad741d086a50325f9******

示例

正常返回示例

JSON格式

{
  "RequestId": "******42-E8E1-4FBB-8E52-F4225C******",
  "TaskId": "******22dad741d086a50325f9******"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
上一篇: 工作流 下一篇: GetWorkflowTask - 查询工作流任务