Use CancelJob to cancel a transcoding job - ApsaraVideo Media Processing - Alibaba Cloud - ApsaraVideo Media Processing

Operation description

You can cancel a transcoding job only if the job is in the Submitted state.
Before you cancel a job, call the UpdatePipeline operation to set the MPS queue status to Paused. This suspends job scheduling. After the job is canceled, you must set the queue status back to Active so that remaining jobs can be scheduled.

QPS limit

You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. For more information, see QPS limit.

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:CancelJob

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobId	string	Yes	The ID of the transcoding job to cancel. You can obtain the job ID from the MPS console by choosing Tasks in the left-side navigation pane, or from the response of the SubmitJobs operation.	d1ce4d3efcb549419193f50f1fcd****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5
JobId	string	The ID of the job.	d1ce4d3efcb549419193f50f1fcd****

Examples

Success response

JSON format

{
  "RequestId": "338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5",
  "JobId": "d1ce4d3efcb549419193f50f1fcd****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.