UpdateMediaWorkflow - 更新媒体工作流的拓扑结构

更新媒体工作流。

接口说明

  • 本接口用于更新媒体工作流的拓扑结构。如需更新媒体工作流触发模式,请参见更新媒体工作流触发模式
  • 删除或停用工作流后,工作流将无法使用。此时,如果上传文件至工作流指定的 Bucket 路径中,也不会自动触发工作流执行。

注意 删除或停用工作流后,不会影响已经提交的任务。如果提交任务后删除或停用工作流,已经进入处理排队中的任务将无法取消,会正常执行并收取对应的费用。

QPS 限制

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

调试

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

授权信息

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

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

请求参数

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

需要更新的媒体工作流 ID,可以通过 MPS 控制台 > 工作流管理 > 工作流设置获取。

6307eb0d3f85477882d205aa040f****
Topologystring

更新的媒体工作流拓扑结构。JSON 对象,包括活动列表及活动依赖。

说明 OSS 的地域需要与当前 MPS 所在地域保持一致。
{ "Activities": { "Act-Start": { "Parameters": { "PipelineId": "130266f58161436a80bf07cb12c8****", "InputFile": "{\"Bucket\": \"example-bucket-****\",\"Location\": \"cn-shanghai\"}" }, "Type": "Start" }, "Act-Report": { "Parameters": {}, "Type": "Report" }, "Act-Transcode-M3U8": { "Parameters": { "Outputs": "[{\"Object\":\"transcode/{ObjectPrefix}{FileName}\",\"TemplateId\": \"957d1719ee85ed6527b90cf62726****\"}]", "OutputBucket": "example-bucket-****", "OutputLocation": "cn-shanghai" }, "Type": "Transcode" } }, "Dependencies": { "Act-Start": [ "Act-Transcode-M3U8" ], "Act-Report": [], "Act-Transcode-M3U8": [ "Act-Report" ] } }
Namestring

媒体工作流名称。

  • 不能为空串。
  • 同一账号下的工作流名称不可重复。
  • 不超过 64 个字符。
  • UTF-8 编码。
mediaworkflow-example
TriggerModestring

触发模式。 取值:

  • OssAutoTrigger:自动触- 发。
  • NotInAuto:不自动触发。
OssAutoTrigger

返回参数

名称类型描述示例值
object

返回参数。

RequestIdstring

请求 ID。

7D752035-97DA-54E5-88E2-E8405EEA****
MediaWorkflowobject

媒体工作流详细信息。

CreationTimestring

创建时间。

2016-04-01T05:29:38Z
MediaWorkflowIdstring

更新的媒体工作流 ID。

6307eb0d3f85477882d205aa040f****
Statestring

媒体工作流状态。可取值:

  • Inactive:已停用。

  • Active:已启用。

Active
TriggerModestring

触发模式。可取值:

  • OssAutoTrigger:自动触发。

  • NotInAuto:不自动触发。

OssAutoTrigger
Namestring

媒体工作流名称。

examp-mediaworkflow-****
Topologystring

媒体工作流拓扑结构。

{ "Activities": { "Act-Start": { "Parameters": { "PipelineId": "130266f58161436a80bf07cb12c8****", "InputFile": "{\"Bucket\": \"example-bucket-****\",\"Location\": \"cn-shanghai\"}" }, "Type": "Start" }, "Act-Report": { "Parameters": {}, "Type": "Report" }, "Act-Transcode-M3U8": { "Parameters": { "Outputs": "[{\"Object\":\"transcode/{ObjectPrefix}{FileName}\",\"TemplateId\": \"957d1719ee85ed6527b90cf62726****\"}]", "OutputBucket": "example-bucket-****", "OutputLocation": "cn-shanghai" }, "Type": "Transcode" } }, "Dependencies": { "Act-Start": [ "Act-Transcode-M3U8" ], "Act-Report": [], "Act-Transcode-M3U8": [ "Act-Report" ] } }

示例

正常返回示例

JSON格式

{
  "RequestId": "7D752035-97DA-54E5-88E2-E8405EEA****",
  "MediaWorkflow": {
    "CreationTime": "2016-04-01T05:29:38Z",
    "MediaWorkflowId": "6307eb0d3f85477882d205aa040f****",
    "State": "Active",
    "TriggerMode": "OssAutoTrigger",
    "Name": "examp-mediaworkflow-****",
    "Topology": "{\n      \"Activities\": {\n            \"Act-Start\": {\n                  \"Parameters\": {\n                        \"PipelineId\": \"130266f58161436a80bf07cb12c8****\",\n                        \"InputFile\": \"{\\\"Bucket\\\": \\\"example-bucket-****\\\",\\\"Location\\\": \\\"cn-shanghai\\\"}\"\n                  },\n                  \"Type\": \"Start\"\n            },\n            \"Act-Report\": {\n                  \"Parameters\": {},\n                  \"Type\": \"Report\"\n            },\n            \"Act-Transcode-M3U8\": {\n                  \"Parameters\": {\n                        \"Outputs\": \"[{\\\"Object\\\":\\\"transcode/{ObjectPrefix}{FileName}\\\",\\\"TemplateId\\\": \\\"957d1719ee85ed6527b90cf62726****\\\"}]\",\n                        \"OutputBucket\": \"example-bucket-****\",\n                        \"OutputLocation\": \"cn-shanghai\"\n                  },\n                  \"Type\": \"Transcode\"\n            }\n      },\n      \"Dependencies\": {\n            \"Act-Start\": [\n                  \"Act-Transcode-M3U8\"\n            ],\n            \"Act-Report\": [],\n            \"Act-Transcode-M3U8\": [\n                  \"Act-Report\"\n            ]\n      }\n}"
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史