Use GetUrlUploadInfos to query URL-based upload job information - Intelligent Media Services - Alibaba Cloud - Intelligent Media Services

Queries the information about URL-based upload jobs.

Operation description

Query the information, including the upload status, user data, creation time, and completion time, about URL-based upload jobs based on the returned job IDs or the URLs used during the upload.

If an upload job fails, you can view the error code and error message. If an upload job is successful, you can obtain the video 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

ice:GetUrlUploadInfos

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobIds	string	No	The IDs of the upload jobs. You can specify one or more job IDs. You can obtain the job IDs from the response parameter JobId of the UploadMediaByURL operation. You can specify a maximum of 10 job IDs. Separate the job IDs with commas (,). Note You must specify either JobIds or UploadURLs. If you specify both parameters, only the value of JobIds takes effect.	df2ac80b481346daa1db6a7c40edc7f8
UploadURLs	string	No	The upload URLs of the source files. You can specify a maximum of 10 URLs. Separate the URLs with commas (,). Note The URLs must be encoded. If a media file is uploaded multiple times, we recommend that you specify the URL of the media file only once in this parameter. You must specify either JobIds or UploadURLs. If you specify both parameters, only the value of JobIds takes effect.	https://media.w3.org/2010/05/sintel/trailer.mp4

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	****11-DB8D-4A9A-875B-275798****
NonExists	array	The job IDs or upload URLs that do not exist.
	string	The job ID or upload URL that does not exist. Job IDs are returned for this parameter if you have specified JobIds in the request, and upload URLs are returned if you have specified UploadURLs in the request.	['e3e71ae8e4a46e4893d8cadce50c3bd0']
URLUploadInfoList	array<object>	The details about URL-based upload jobs.
	object	The information about the URL-based upload job. For more information, see the "URLUploadInfo: the information about a URL-based upload job" section of the "Basic data types" topic.
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.	2021-11-07T10:03:37Z
Status	string	The status of the upload job. For more information about the valid values of the parameter, see the "Status: the status of a URL-based upload job" section of the Basic data types topic.	Normal
ErrorMessage	string	The error message returned if the upload job failed.	Success
ErrorCode	string	The error code returned if the upload job failed.	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.	2021-11-26 21:47:37
JobId	string	The ID of the upload job.	3829500c0fef429fa4ec1680b122d***
UserData	string	The user data. The value is a JSON string.	{"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.	5014ca70f08171ecbf940764a0fd6***
FileSize	string	The file size. Unit: bytes.	64610

Examples

Success response

JSON format

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "NonExists": [
    "['e3e71ae8e4a46e4893d8cadce50c3bd0']"
  ],
  "URLUploadInfoList": [
    {
      "CreationTime": "2021-11-07T10:03:37Z",
      "Status": "Normal",
      "ErrorMessage": "Success",
      "ErrorCode": "200",
      "CompleteTime": "2021-11-26 21:47:37",
      "JobId": "3829500c0fef429fa4ec1680b122d***",
      "UserData": "{\"MessageCallback\":\"{\"CallbackURL\":\"http://example.aliyundoc.com\"}\", \"Extend\":\"{\"localId\":\"***\", \"test\":\"www\"}\"}",
      "UploadURL": "http://****.mp4",
      "MediaId": "5014ca70f08171ecbf940764a0fd6***",
      "FileSize": "64610"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.