Use GetURLUploadInfos to query URL-based upload jobs - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Retrieves URL upload information.

Operation description

Retrieves URL upload information by using the JobId returned during URL-based upload or the URL used for upload. The information includes the URL upload status, UserData, creation time, and completion time.
This operation only supports querying upload task data within the last year.
This operation currently supports only the following service regions: China (Shanghai) and Singapore.
After you call the UploadMediaByURL operation to upload a media file to ApsaraVideo VOD, you can call this operation to query the upload information of a specified media file by using the upload task IDs (JobIds) or the source file URLs (UploadURLs).
When calling this operation, you must specify either JobIds or UploadURLs. If both are specified, only JobIds is processed.
If the media upload fails, you can call this operation to view the error code and error message. If the media upload succeeds, you can call this operation to view the corresponding media ID.

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:GetURLUploadInfos

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobIds	string	No	The list of upload task IDs (JobId). The list consists of one or more JobId values. A JobId is the value of the JobId parameter returned when you call the UploadMediaByURL 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.	86c1925fba0**,7afb201e7fa,2cc4997378**
UploadURLs	string	No	The list of source video file URLs. Separate multiple URLs with commas (,). A maximum of 10 URLs are supported. Note URL-encode the URLs before use. If the same URL video is uploaded multiple times, pass in a single URL for the query. You must specify either JobIds or UploadURLs. If both are specified, only JobIds is processed.	http://****.mp4

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	25818875-5F78-4AF6-D7393642CA58****
NonExists	array	The list of upload task IDs or URLs that do not exist.
	string	The list of upload task IDs or URLs that do not exist.	["**1", "**2"]
URLUploadInfoList	array<object>	The list of URL upload information. For more information about the fields and descriptions, see URLUploadInfo.
	object	The details of URL upload information.
CreationTime	string	The creation time. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2019-01-01T01:01:01Z
Status	string	The status of the URL-based upload task. For more information about the status values and descriptions, see Status.	SUCCESS
ErrorMessage	string	The error message.	error_message
ErrorCode	string	The error code.	200
CompleteTime	string	The completion time. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2019-01-01T01:11:01Z
JobId	string	The upload task ID.	86c1925fba0****
UserData	string	The custom settings. The value is a JSON string. For more information, see UserData.	{"MessageCallback":"{"CallbackURL":"http://example.aliyundoc.com"}", "Extend":"{"localId":"***", "test":"www"}"}
UploadURL	string	The URL of the source video file. Note A maximum of 100 records can be returned.	http://****.mp4
MediaId	string	The media ID.	93ab850b4f6f54b6e91d24d81d4****
FileSize	string	The file size. Unit: bytes.	24
RegisteredMediaId	string		93ab850b4f654b6e91d24d81d44****

Examples

Success response

JSON format

{
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "NonExists": [
    "[\"****1\", \"****2\"]"
  ],
  "URLUploadInfoList": [
    {
      "CreationTime": "2019-01-01T01:01:01Z",
      "Status": "SUCCESS",
      "ErrorMessage": "error_message",
      "ErrorCode": "200",
      "CompleteTime": "2019-01-01T01:11:01Z",
      "JobId": "86c1925fba0****",
      "UserData": "{\"MessageCallback\":\"{\"CallbackURL\":\"http://example.aliyundoc.com\"}\", \"Extend\":\"{\"localId\":\"***\", \"test\":\"www\"}\"}",
      "UploadURL": "http://****.mp4",
      "MediaId": "93ab850b4f6f54b6e91d24d81d4****",
      "FileSize": "24",
      "RegisteredMediaId": "93ab850b4f654b6e91d24d81d44****"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.