CancelUrlUploadJobs - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Cancels URL-based upload jobs in the queue.

Operation description

You can cancel only URL-based upload jobs in the Pending state. You can query the status of a URL-based upload job by calling the GetURLUploadInfos operation.
You cannot cancel an upload job that already starts.

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
JobIds	string	No	The IDs of the upload jobs. You can obtain the job IDs from PlayInfo in the response to the GetPlayInfo operation. You can specify a maximum of 10 IDs. Separate multiple IDs with commas (,). Note You must specify either JobIds or UploadUrls. If you specify both the JobIds and UploadUrls parameters, only the value of the JobIds parameter takes effect.	341c92e6c18dc435ee31253685**,0193d395194a83ad6ee2ef27a5b5**
UploadUrls	string	No	The upload URLs of source video files. Separate multiple URLs with commas (,). You can specify a maximum of 10 URLs. Note You must encode the URLs before you use the URLs. You must specify either JobIds or UploadUrls. If you specify both the JobIds and UploadUrls parameters, only the value of the JobIds parameter takes effect.	http://www.example.aliyundoc.com/*/video01.mp4,http://www.example.aliyundoc.com/*/video02.mp4

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	25818875-5F78-4D5C-3C3D-D7393642****
CanceledJobs	array	The IDs of canceled jobs.
	string	The ID of the canceled job. The return value is JobId.	341c92e6c18dc435ee31253685**,0193d395194a83ad6ee2ef27a5b5**
NonExists	array	The jobs that do not exist.
	string	The job ID or URL that does not exist. If you specify JobIds in the request, the job IDs that do not exist are returned. If you specify UploadURL in the request, the upload URLs that do not exist are returned.	http://www.example.aliyundoc.com/*/video01.mp4,http://www.example.aliyundoc.com/*/video02.mp4

Examples

Sample success responses

JSONformat

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

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

Change history

Change time

Summary of changes

Operation

2023-12-06

The internal configuration of the API is changed, but the call is not affected

see changesets

Change item	Change content
	The internal configuration of the API is changed, but the call is not affected.