Disable MPS Media Workflows with DeactivateMediaWorkflow API - ApsaraVideo MPS - Alibaba Cloud - ApsaraVideo Media Processing

Operation description

The time when the media workflow was created.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mts:DeactivateMediaWorkflow

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MediaWorkflowId	string	Yes	The ID of the media workflow to deactivate.	93ab850b4f6f44eab54b6e9181d4****

Response elements

Element	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 calls per second exceeds the limit, throttling is triggered and your business may be affected. We recommend that you take note of this 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 to deactivate. To obtain the media workflow ID, 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

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.