CancelUrlUploadJobs -

Usage notes

You can cancel only a URL-based upload job 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.

QPS limit

You can call this operation up to 50 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation. For more information, see QPS limits on API operations in ApsaraVideo VOD.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	CancelUrlUploadJobs	The operation that you want to perform. Set the value to CancelUrlUploadJobs.
JobIds	String	No	341c92e6c18dc435ee31253685**,0193d395194a83ad6ee2ef27a5b5**	The IDs of the upload jobs. You can obtain the job IDs in the response parameter PlayInfo of the GetPlayInfo operation. You can specify a maximum of 10 IDs. Separate multiple IDs with commas (,). Note You must set one of the JobIds and the UploadUrls parameters. If you set both the JobIds and UploadUrls parameters, only the value of the JobIds parameter takes effect.
UploadUrls	String	No	http://www.example.aliyundoc.com/*/video01.mp4,http://www.example.aliyundoc.com/*/video02.mp4	The upload URLs of source 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 set one of the JobIds and the UploadUrls parameters. If you set both the JobIds and UploadUrls parameters, only the value of the JobIds parameter takes effect.

Response parameters


Parameter	Type	Example	Description
RequestId	String	25818875-5F78-4D5C-3C3D-D7393642****	The ID of the request.
CanceledJobs	Array of String	341c92e6c18dc435ee31253685**,0193d395194a83ad6ee2ef27a5b5**	The IDs of canceled jobs.
NonExists	Array of String	http://www.example.aliyundoc.com/*/video01.mp4,http://www.example.aliyundoc.com/*/video02.mp4	The job IDs or upload URLs that do not exist. If you set the request parameter JobIds, the job IDs that do not exist are returned. If you set the request parameter UploadUrls, the upload URLs that do not exist are returned.

Examples

Sample requests

http(s)://vod.cn-shanghai.aliyuncs.com/?Action=CancelUrlUploadJobs
&JobIds=341c92e6c18dc435ee31253685****,0193d395194a83ad6ee2ef27a5b5****
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<CancelUrlUploadJobsResponse>
    <RequestId>25818875-5F78-4D5C-3C3D-D7393642****</RequestId>
    <CanceledJobs>341c92e6c18dc435ee31253685****,0193d395194a83ad6ee2ef27a5b5****</CanceledJobs>
    <NonExists>http://www.example.aliyundoc.com/***/video01.mp4,http://www.example.aliyundoc.com/***/video02.mp4</NonExists>
</CancelUrlUploadJobsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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 API Error Center.