Updates the trigger mode of a media workflow.

Usage notes

You can call this operation only to modify the trigger mode of a workflow. To modify other information, call the UpdateMediaWorkflow operation.

QPS limit

You can call this operation up to 100 times per second per account. If the number of 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 UpdateMediaWorkflowTriggerMode

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

MediaWorkflowId String Yes e00732b977da427d9177a4dee646****

The ID of the media workflow to be updated. To obtain the workflow ID, you can log on to the ApsaraVideo Media Processing (MPS) console and choose Workflows > Workflow Settings.

TriggerMode String Yes NotInAuto

The trigger mode of the media workflow. Valid values:

  • OssAutoTrigger: automatically triggers the media workflow.
  • NotInAuto: does not automatically trigger the media workflow.

Response parameters

Parameter Type Example Description
RequestId String 16CD0CDD-457E-420D-9755-8385075A1234

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 e00732b977da427d9177a4dee646****

The ID of the media workflow.

State String Inactive

The status of the media workflow. Valid values:

  • Inactive: disabled
  • Active: enabled
TriggerMode String NotInAuto

The trigger mode of the media workflow. Valid values:

  • OssAutoTrigger: The media workflow is automatically triggered.
  • NotInAuto: The media workflow is not automatically triggered.
Name String example-mediaworkflow-****

The name of the media workflow.

Topology String {mediaworkflow","State":"Active","Topology":"{\"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\"]}}","MediaWorkflowId":"93ab850b4f6f44eab54b6e91d24d****"}]},"RequestId":"16CD0CDD-457E-420D-9755-8385075A1234"}

The topology of the media workflow.

Examples

Sample requests

http(s)://mts.cn-hangzhou.aliyuncs.com/?Action=UpdateMediaWorkflowTriggerMode
&MediaWorkflowId=e00732b977da427d9177a4dee646****
&TriggerMode=NotInAuto
&<Common request parameters>

Sample success responses

XML format

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

<UpdateMediaWorkflowTriggerModeResponse>
    <RequestId>16CD0CDD-457E-420D-9755-8385075A1234</RequestId>
    <MediaWorkflow>
        <CreationTime>2016-04-01T05:29:37Z</CreationTime>
        <MediaWorkflowId>e00732b977da427d9177a4dee646****</MediaWorkflowId>
        <State>Inactive</State>
        <TriggerMode>NotInAuto</TriggerMode>
        <Name>example-mediaworkflow-****</Name>
        <Topology>{mediaworkflow","State":"Active","Topology":"{\"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\"]}}","MediaWorkflowId":"93ab850b4f6f44eab54b6e91d24d****"}]},"RequestId":"16CD0CDD-457E-420D-9755-8385075A1234"}</Topology>
    </MediaWorkflow>
</UpdateMediaWorkflowTriggerModeResponse>

JSON format

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

{
  "RequestId" : "16CD0CDD-457E-420D-9755-8385075A1234",
  "MediaWorkflow" : {
    "CreationTime" : "2016-04-01T05:29:37Z",
    "MediaWorkflowId" : "e00732b977da427d9177a4dee646****",
    "State" : "Inactive",
    "TriggerMode" : "NotInAuto",
    "Name" : "example-mediaworkflow-****",
    "Topology" : "{mediaworkflow\",\"State\":\"Active\",\"Topology\":\"{\\\"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\\\"]}}\",\"MediaWorkflowId\":\"93ab850b4f6f44eab54b6e91d24d****\"}]},\"RequestId\":\"16CD0CDD-457E-420D-9755-8385075A1234\"}"
  }
}

Error codes

For a list of error codes, visit the API Error Center.