DeactivateMediaWorkflow - ApsaraVideo Media Processing - Alibaba Cloud Documentation Center

Disables 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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
MediaWorkflowId	string	Yes	The ID of the media workflow that is deactivated.	93ab850b4f6f44eab54b6e9181d4****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The name of the media workflow that is deactivated.	16CD0CDD-457E-420D-9755-8385075A1234
MediaWorkflow	object	The topology of the media workflow.
CreationTime	string	After you deactivate a media workflow, you can modify the workflow information. 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. 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
MediaWorkflowId	string	The ID of the media workflow that you want to deactivate. 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.	93ab850b4f6f44eab54b6e9181d4****
State	string	The topology of the media workflow.The status of the media workflow. The value is Inactive.	Inactive
Name	string	The details of the media workflow.	example-mediaworkflow-****
Topology	string	The status of the media workflow. The value is Inactive.	{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"}

Examples

Sample success responses

JSONformat

{
  "RequestId": "16CD0CDD-457E-420D-9755-8385075A1234",
  "MediaWorkflow": {
    "CreationTime": "2016-04-01T05:29:37Z",
    "MediaWorkflowId": "93ab850b4f6f44eab54b6e9181d4****",
    "State": "Inactive",
    "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 Service error codes.

Change history

Change time	Summary of changes	Operation

No change history