Activates a media workflow.

Usage notes

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.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ActivateMediaWorkflow

The operation that you want to perform. Set the value to ActivateMediaWorkflow.

MediaWorkflowId String Yes 93ab850b4f6f44eab54b6e9181d4****

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

Response parameters

Parameter Type Example Description
RequestId String A1326BD4-30B1-4CB6-Q123-3330B877B0D4

The ID of the request.

MediaWorkflow Object

The details of the media workflow.

CreationTime String 2016-04-01T05:29:37Z

The time when the media workflow was created.

MediaWorkflowId String 93ab850b4f6f44eab54b6e9181d4****

The ID of the media workflow.

State String Active

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

Name String mediaworkflow-example

The name of the media workflow.

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

The topology of the media workflow.

Examples

Sample requests

http(s)://mts.cn-hangzhou.aliyuncs.com/?Action=ActivateMediaWorkflow
&MediaWorkflowId=93ab850b4f6f44eab54b6e9181d4****
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ActivateMediaWorkflowResponse>
    <RequestId>A1326BD4-30B1-4CB6-Q123-3330B877B0D4</RequestId>
    <MediaWorkflow>
        <CreationTime>2016-04-01T05:29:37Z</CreationTime>
        <MediaWorkflowId>93ab850b4f6f44eab54b6e9181d4****</MediaWorkflowId>
        <State>Active</State>
        <Name>mediaworkflow-example</Name>
        <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\"]}}</Topology>
    </MediaWorkflow>
</ActivateMediaWorkflowResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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 API Error Center.