All Products
Search
Document Center

ApsaraVideo Media Processing:ActivateMediaWorkflow

Last Updated:Mar 03, 2024

Activates a media workflow.

Operation description

The time when the media workflow was created.

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.

93ab850b4f6f44eab54b6e9181d4****

Response parameters

ParameterTypeDescriptionExample
object

The status of the media workflow. The value is Active.

RequestIdstring

The name of the media workflow.

A1326BD4-30B1-4CB6-Q123-3330B877B0D4
MediaWorkflowobject

The topology of the media workflow.

CreationTimestring

You can call this operation to activate a media workflow that has been deactivated. After you activate a media workflow, you cannot modify the workflow information, such as the name, topology, or trigger mode. A media workflow is activated by default after it is created.

Limits on QPS

You can call this operation up to 100 times per second. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation. For more information, see QPS limits.

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

The ID of the media workflow. You can obtain the ID from the response of the AddMediaWorkflow operation.

93ab850b4f6f44eab54b6e9181d4****
Statestring

The topology of the media workflow.

Active
Namestring

The details of the media workflow.

mediaworkflow-example
Topologystring

The status of the media workflow. The value is Active.

{\"Activities\":{\"Act-Start\":{\"Parameters\":{\"PipelineId\":\"130266f58161436a80bf07cb12c8****\",\"InputFile\":\"{\\\"Bucket\\\": \\\"example\\\",\\\"Location\\\": \\\"oss-cn-hangzhou\\\"}\"},\"Type\":\"Start\"},\"Act-Report\":{\"Parameters\":{},\"Type\":\"Report\"},\"Act-Transcode-M3U8\":{\"Parameters\":{\"Outputs\":\"[{\\\"OutputObject\\\":\\\"transcode%2F%7BObjectPrefix%7D%7BFileName%7D\\\",\\\"TemplateId\\\": \\\"957d1719ee85ed6527b90cf62726****\\\"}]\",\"OutputBucket\":\"panda-vod-hls\",\"OutputLocation\":\"oss-cn-hangzhou\"},\"Type\":\"Transcode\"}},\"Dependencies\":{\"Act-Start\":[\"Act-Transcode-M3U8\"],\"Act-Report\":[],\"Act-Transcode-M3U8\":[\"Act-Report\"]}}

Examples

Sample success responses

JSONformat

{
  "RequestId": "A1326BD4-30B1-4CB6-Q123-3330B877B0D4",
  "MediaWorkflow": {
    "CreationTime": "2016-04-01T05:29:37Z",
    "MediaWorkflowId": "93ab850b4f6f44eab54b6e9181d4****",
    "State": "Active",
    "Name": "mediaworkflow-example",
    "Topology": "{\\\"Activities\\\":{\\\"Act-Start\\\":{\\\"Parameters\\\":{\\\"PipelineId\\\":\\\"130266f58161436a80bf07cb12c8****\\\",\\\"InputFile\\\":\\\"{\\\\\\\"Bucket\\\\\\\": \\\\\\\"example\\\\\\\",\\\\\\\"Location\\\\\\\": \\\\\\\"oss-cn-hangzhou\\\\\\\"}\\\"},\\\"Type\\\":\\\"Start\\\"},\\\"Act-Report\\\":{\\\"Parameters\\\":{},\\\"Type\\\":\\\"Report\\\"},\\\"Act-Transcode-M3U8\\\":{\\\"Parameters\\\":{\\\"Outputs\\\":\\\"[{\\\\\\\"OutputObject\\\\\\\":\\\\\\\"transcode%2F%7BObjectPrefix%7D%7BFileName%7D\\\\\\\",\\\\\\\"TemplateId\\\\\\\": \\\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\\"}]\\\",\\\"OutputBucket\\\":\\\"panda-vod-hls\\\",\\\"OutputLocation\\\":\\\"oss-cn-hangzhou\\\"},\\\"Type\\\":\\\"Transcode\\\"}},\\\"Dependencies\\\":{\\\"Act-Start\\\":[\\\"Act-Transcode-M3U8\\\"],\\\"Act-Report\\\":[],\\\"Act-Transcode-M3U8\\\":[\\\"Act-Report\\\"]}}"
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history