All Products
Search
Document Center

ApsaraVideo VOD:CancelUrlUploadJobs

Last Updated:Nov 09, 2022

Cancels a URL-based upload job in the queue.

Operation Description

  • 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.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operateaccess levelResource typeconditional keywordAssociation operation
vod:CancelUrlUploadJobsRead
    All resources
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
JobIdsstringNo

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 (,).
NoteYou 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.
341c92e6c18dc435ee31253685****,0193d395194a83ad6ee2ef27a5b5****
UploadUrlsstringNo

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.
  • http://www.example.aliyundoc.com/***/video01.mp4,http://www.example.aliyundoc.com/***/video02.mp4

    Response parameters

    ParameterTypeDescriptionExample
    object

    The returned data.

    RequestIdstring

    The ID of the request.

    25818875-5F78-4D5C-3C3D-D7393642****
    CanceledJobsarray

    The IDs of canceled jobs.

    string

    The IDs of canceled jobs. The return value is JobId.

    341c92e6c18dc435ee31253685****,0193d395194a83ad6ee2ef27a5b5****
    NonExistsarray

    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.

    string

    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.

    http://www.example.aliyundoc.com/***/video01.mp4,http://www.example.aliyundoc.com/***/video02.mp4

    Example

    Normal return example

    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 API error center.