GetURLUploadInfos - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Queries the information about URL-based upload jobs.

Operation description

You can query the information about a URL-based upload job by specifying the upload URL or using the job ID returned when you upload media files. The information includes the status of the upload job, custom configurations, the time when the job was created, and the time when the job was complete.

If the upload fails, you can view the error code and error message. If the upload is successful, you can obtain the video ID.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

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 Key: the condition key that is defined by the cloud service.
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.

Operation	Access level	Resource type	Condition key	Associated operation
vod:GetURLUploadInfos	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
JobIds	string	No	The one or more IDs of upload jobs. You can obtain the job IDs in the response parameter JobId of the UploadMediaByURL 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.	86c1925fba0**,7afb201e7fa,2cc4997378**
UploadURLs	string	No	The one or more upload URLs of the 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. If a media file is uploaded multiple times, pass the URL of the media file to this parameter only once. 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://****.mp4

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	25818875-5F78-4AF6-D7393642CA58****
NonExists	array	The job IDs or upload URLs that do not exist.
ExistId	string	The job ID or upload URL.	["**1", "**2"]
URLUploadInfoList	array<object>	The information about URL-based upload jobs. For more information, see the "URLUploadInfo: the information about a URL-based upload job" section of the Basic structures topic.
UrlUploadJobInfoDTO	object
CreationTime	string	The time when the upload job was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2019-01-01T01:01:01Z
Status	string	The status of the URL-based upload job. For more information about the valid values and value description of the parameter, see the "Status: the status of a video" section of the Basic structures topic.	SUCCESS
ErrorMessage	string	The error message returned.	error_message
ErrorCode	string	The error code returned.	200
CompleteTime	string	The time when the upload job was complete. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2019-01-01T01:11:01Z
JobId	string	The ID of the upload job.	86c1925fba0****
UserData	string	The custom configurations. The value is a JSON string. For more information, see the "UserData: specifies the custom configurations for media upload" section of the Request parameters topic.	{"MessageCallback":"{"CallbackURL":"http://example.aliyundoc.com"}", "Extend":"{"localId":"***", "test":"www"}"}
UploadURL	string	The upload URL of the source file. Note A maximum of 100 URLs can be returned.	http://****.mp4
MediaId	string	The ID of the uploaded media file.	93ab850b4f6f54b6e91d24d81d4****
FileSize	string	The size of the uploaded media file. Unit: byte.	24

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history