AddMediaWorkflow - 新增媒体工作流 - 媒体处理

接口说明

本接口可以定义媒体工作流的拓扑结构（DAG）、活动以及依赖关系。活动详情，请参见媒体工作流活动介绍。使用本接口创建的工作流可以在媒体处理控制台查看并调用。
MPS 媒体工作流仅支持通过前缀（文件路径）自动触发工作流，不支持通过后缀名触发工作流执行。详细触发规则，请参见媒体工作流的文件触发匹配规则。

QPS 限制

本接口的单用户 QPS 限制为 100 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 QPS 限制。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

mts:AddMediaWorkflow

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
Name	string	是	媒体工作流名称。不能为空串。同一账号下的工作流名称不可重复。不超过 64 个字符。 UTF-8 编码。	mediaworkflow-example
Topology	string	是	媒体工作流拓扑结构。格式为 JSON 对象，包括活动列表及活动依赖。更多信息请参见下文Topology 示例。说明 OSS 的地域需要与当前 MPS 所在地域保持一致。	{"Activities": {"mediaworkflow-example": {"Parameters": {"Outputs": "[{\"OutputObject\":\"examplebucket/output/{RunId}/TRANSCODE_165941222**/{FileName}\",\"TemplateId\":\"S00000001-200010\",\"TemplateName\":\"MP4-流畅\"}]","OutputBucket": "examplebucket","OutputLocation": "oss-cn-shanghai"},"Type": "Transcode"},"Act-Start": {"Parameters": {"PipelineId": "a7d481f07d8c45da88c71853ce7d**","InputFile": "{\"Bucket\":\"example-input\",\"Location\":\"oss-cn-shanghai\",\"ObjectPrefix\":\"mps-test/input/\"}"},"Type": "Start"},"Act-Report": {"Parameters": {"PublishType": "Manual"},"Type": "Report"}},"Dependencies": {"mediaworkflow-example": ["Act-Report"],"Act-Start": ["mediaworkflow-example"],"Act-Report": []}}
TriggerMode	string	否	触发模式。取值： OssAutoTrigger：自动触发。 NotInAuto：不自动触发。	OssAutoTrigger

Topology 示例

说明

OSS 的地域需要与当前 MPS 所在地域保持一致。

{
  "Activities": {
    "mediaworkflow-example": {
      "Parameters": {
        "Outputs": "[{\"OutputObject\":\"examplebucket/output/{RunId}/TRANSCODE_165941222****/{FileName}\",\"TemplateId\":\"S00000001-200010\",\"TemplateName\":\"MP4-流畅\"}]",
        "OutputBucket": "examplebucket",
        "OutputLocation": "oss-cn-shanghai"
      },
      "Type": "Transcode"
    },
    "Act-Start": {
      "Parameters": {
        "PipelineId": "a7d481f07d8c45da88c71853ce7d****",
        "InputFile": "{\"Bucket\":\"example-input\",\"Location\":\"oss-cn-shanghai\",\"ObjectPrefix\":\"mps-test/input/\"}"
      },
      "Type": "Start"
    },
    "Act-Report": {
      "Parameters": {
        "PublishType": "Manual"
      },
      "Type": "Report"
    }
  },
  "Dependencies": {
    "mediaworkflow-example": ["Act-Report"],
    "Act-Start": ["mediaworkflow-example"],
    "Act-Report": []
  }
}

返回参数

名称	类型	描述	示例值
	object	返回参数。
RequestId	string	请求 ID。	F1D21261-ADB9-406A-1234-491382139D59
MediaWorkflow	object	媒体工作流详细信息。
CreationTime	string	创建时间。	016-04-01T05:29:37Z
MediaWorkflowId	string	媒体工作流 ID。建议您保存此 ID 便于后续对此工作流进行其他操作。	e00732b977da427d9177a4deb1aa****
State	string	媒体工作流状态。新建的工作流默认为 Active（激活）状态。	Active
TriggerMode	string	触发模式。取值： OssAutoTrigger：自动触发。 NotInAuto：不自动触发。	OssAutoTrigger
Name	string	媒体工作流名称。	mediaworkflow-example
Topology	string	媒体工作流拓扑结构。格式为 JSON 对象，包括活动列表及活动依赖。	{"Activities": {"mediaworkflow-example": {"Parameters": {"Outputs": "[{\"OutputObject\":\"examplebucket/output/{RunId}/TRANSCODE_165941222**/{FileName}\",\"TemplateId\":\"S00000001-200010\",\"TemplateName\":\"MP4-流畅\"}]","OutputBucket": "examplebucket","OutputLocation": "oss-cn-shanghai"},"Type": "Transcode"},"Act-Start": {"Parameters": {"PipelineId": "a7d481f07d8c45da88c71853ce7d**","InputFile": "{\"Bucket\":\"example-input\",\"Location\":\"oss-cn-shanghai\",\"ObjectPrefix\":\"mps-test/input/\"}"},"Type": "Start"},"Act-Report": {"Parameters": {"PublishType": "Manual"},"Type": "Report"}},"Dependencies": {"mediaworkflow-example": ["Act-Report"],"Act-Start": ["mediaworkflow-example"],"Act-Report": []}}

示例

正常返回示例

JSON格式

{
  "RequestId": "F1D21261-ADB9-406A-1234-491382139D59",
  "MediaWorkflow": {
    "CreationTime": "016-04-01T05:29:37Z",
    "MediaWorkflowId": "e00732b977da427d9177a4deb1aa****",
    "State": "Active",
    "TriggerMode": "OssAutoTrigger",
    "Name": "mediaworkflow-example",
    "Topology": "{\"Activities\": {\"mediaworkflow-example\": {\"Parameters\": {\"Outputs\": \"[{\\\"OutputObject\\\":\\\"examplebucket/output/{RunId}/TRANSCODE_165941222****/{FileName}\\\",\\\"TemplateId\\\":\\\"S00000001-200010\\\",\\\"TemplateName\\\":\\\"MP4-流畅\\\"}]\",\"OutputBucket\": \"examplebucket\",\"OutputLocation\": \"oss-cn-shanghai\"},\"Type\": \"Transcode\"},\"Act-Start\": {\"Parameters\": {\"PipelineId\": \"a7d481f07d8c45da88c71853ce7d****\",\"InputFile\": \"{\\\"Bucket\\\":\\\"example-input\\\",\\\"Location\\\":\\\"oss-cn-shanghai\\\",\\\"ObjectPrefix\\\":\\\"mps-test/input/\\\"}\"},\"Type\": \"Start\"},\"Act-Report\": {\"Parameters\": {\"PublishType\": \"Manual\"},\"Type\": \"Report\"}},\"Dependencies\": {\"mediaworkflow-example\": [\"Act-Report\"],\"Act-Start\": [\"mediaworkflow-example\"],\"Act-Report\": []}}"
  }
}

错误码

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

变更历史

更多信息，参考变更详情。