GetURLUploadInfos - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Retrieves information about URL-based upload jobs.

Operation description

You can query information about URL-based upload jobs, including the job status, UserData, creation time, and completion time, using the JobId or the source URL.
This operation queries data only for upload jobs created within the last year.
The endpoints for this operation are available only in the following regions: China (Shanghai) and Singapore.
After you upload a media file to ApsaraVideo VOD by calling the UploadMediaByURL operation, you can call this operation to query the upload information using the upload job ID (JobIds) or the source file URL (UploadURLs).
When you call this operation, specify either JobIds or UploadURLs. If you specify both, only JobIds is processed.
If a media asset fails to upload, call this operation to view the error code and error message. If the upload is successful, call this operation to view the 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	A list of upload job IDs. A JobId is the value of the JobId parameter returned when you call the UploadMediaByURL operation. You can specify up to 10 IDs. Separate multiple IDs with commas (,). Note You must specify either JobIds or UploadURLs. If you specify both, only JobIds is processed.	86c1925fba0**,7afb201e7fa,2cc4997378**
UploadURLs	string	No	A list of source video file URLs. Separate multiple URLs with commas (,). You can specify up to 10 URLs. Note URL-encode the URLs before you use them. If a video from the same URL is uploaded multiple times, specify a single URL for the query. You must specify either JobIds or UploadURLs. If you specify both, only JobIds is processed.	http://****.mp4

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	25818875-5F78-4AF6-D7393642CA58****
NonExists	array	A list of IDs of URL-based upload jobs or URLs that do not exist.
	string	A list of IDs of URL-based upload jobs or URLs that do not exist.	["**1", "**2"]
URLUploadInfoList	array<object>	A list of URL upload job details. For more information, see URLUploadInfo.
	object	The details of the URL-based upload job.
CreationTime	string	The time when the job was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format in UTC.	2019-01-01T01:01:01Z
Status	string	The status of the URL-based upload job. For more information about the valid values, see Status.	SUCCESS
ErrorMessage	string	The error message.	error_message
ErrorCode	string	The error code.	200
CompleteTime	string	The time when the job was completed. The time is in the yyyy-MM-ddTHH:mm:ssZ format in UTC.	2019-01-01T01:11:01Z
JobId	string	The ID of the upload job.	86c1925fba0****
UserData	string	Custom settings. This 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 are 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.