Use CancelUrlUploadJobs to cancel URL-based upload jobs - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Operation description

You can cancel only URL upload nodes whose status is Pending. You can call the GetURLUploadInfos operation to query the node status.
Upload nodes that have already started to execute cannot be canceled.
The request parameters JobIds and UploadUrls must have one specified. If both are specified, only JobIds is processed.

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

vod:CancelUrlUploadJobs

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobIds	string	No	The list of task IDs. You can obtain the task ID (JobId) from the PlayInfo struct returned by the GetPlayInfo operation. A maximum of 10 IDs are supported. Separate multiple IDs with commas (,). Note You must specify either JobIds or UploadUrls. If both are specified, only JobIds is processed.	341c92e6c18dc435ee31253685**,0193d395194a83ad6ee2ef27a5b5**
UploadUrls	string	No	The list of source video upload URLs. Separate multiple URLs with commas (,). A maximum of 10 URLs are supported. Note URL-encode the URLs before use. You must specify either JobIds or UploadUrls. If both are specified, only JobIds is processed.	http://www.example.aliyundoc.com/*/video01.mp4,http://www.example.aliyundoc.com/*/video02.mp4

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	25818875-5F78-4D5C-3C3D-D7393642****
CanceledJobs	array	The list of tasks that were successfully canceled.
	string	The list of tasks that were successfully canceled. The return values are JobIds.	341c92e6c18dc435ee31253685**,0193d395194a83ad6ee2ef27a5b5**
NonExists	array	The list of tasks that do not exist.
	string	The list of JobIds or URLs that do not exist. If the request parameter is JobIds, the return values are JobIds. If the request parameter is UploadURLs, the return values are URLs.	http://www.example.aliyundoc.com/*/video01.mp4,http://www.example.aliyundoc.com/*/video02.mp4

Examples

Success response

JSON format

{
  "RequestId": "25818875-5F78-4D5C-3C3D-D7393642****",
  "CanceledJobs": [
    "341c92e6c18dc435ee31253685****,0193d395194a83ad6ee2ef27a5b5****"
  ],
  "NonExists": [
    "http://www.example.aliyundoc.com/***/video01.mp4,http://www.example.aliyundoc.com/***/video02.mp4"
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.