All Products
Search
Document Center

ApsaraVideo Media Processing:UpdateMediaWorkflow

Last Updated:Mar 03, 2024

Updates the topology of a media workflow.

Operation description

  • You can call this operation to update the topology of a media workflow. To update the trigger mode of a media workflow, call the UpdateMediaWorkflowTriggerMode operation.
  • After you delete or deactivate a media workflow, the workflow cannot be used. In this case, the workflow is not automatically triggered when you upload a file to the bucket specified by the workflow.

QPS limit

You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limit.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
MediaWorkflowIdstringYes

The ID of the media workflow that you want to update. To obtain the ID of the media workflow, you can log on to the ApsaraVideo Media Processing (MPS) console and choose Workflows > Workflow Settings in the left-side navigation pane.

6307eb0d3f85477882d205aa040f****
TopologystringYes

The new topology of the media workflow. The value is a JSON object that contains the activity list and activity dependencies.

Note The Object Storage Service (OSS) bucket must reside in the same region as your MPS service.
{ "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" ] } }

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

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

The detailed information about the media workflow.

CreationTimestring

The time when the media workflow was created.

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

The ID of the media workflow that is updated.

6307eb0d3f85477882d205aa040f****
Statestring

The state of the media workflow. Valid values:

  • Inactive: The media workflow is disabled.
  • Active: The media workflow is enabled.
Active
TriggerModestring

The trigger mode of the media workflow. Valid values:

  • OssAutoTrigger: The media workflow is automatically triggered.
  • NotInAuto: The media workflow is not automatically triggered.
OssAutoTrigger
Namestring

The name of the media workflow.

examp-mediaworkflow-****
Topologystring

The topology of the media workflow.

{ "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" ] } }

Examples

Sample success responses

JSONformat

{
  "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}"
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history