All Products
Search
Document Center

ApsaraVideo Media Processing:CancelJob

Last Updated:Sep 27, 2024

Cancels a transcoding job.

Operation description

  • You can cancel a transcoding job only if the job is in the Submitted state.
  • We recommend that you call the UpdatePipeline operation to set the status of the ApsaraVideo Media Processing (MPS) queue to Paused before you cancel a job. This suspends job scheduling in the MPS queue. After the job is canceled, you must set the status of the MPS queue back to Active so that the other jobs in the MPS queue 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. We recommend that you take note of this limit when you call this operation. For more information, see QPS limit.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
mts:CancelJob
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
JobIdstringYes

The ID of the transcoding job to be canceled. You can log on to the MPS console and click Tasks in the left-side navigation pane to obtain job IDs. Alternatively, you can obtain job IDs from the response of the SubmitJobs operation.

d1ce4d3efcb549419193f50f1fcd****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5
JobIdstring

The ID of the job.

d1ce4d3efcb549419193f50f1fcd****

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history