All Products
Search
Document Center

Intelligent Media Services:GetUrlUploadInfos

更新時間:Nov 25, 2024

Queries the information about URL-based upload jobs.

Operation description

You can call this operation to 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.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
ice:GetUrlUploadInfosget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
JobIdsstringNo

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
UploadURLsstringNo

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 parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

******11-DB8D-4A9A-875B-275798******
NonExistsarray

The job IDs or upload URLs that do not exist.

ExistIdstring

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']
URLUploadInfoListarray<object>

The details about URL-based upload jobs.

UrlUploadJobInfoDTOobject

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.

CreationTimestring

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
Statusstring

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
ErrorMessagestring

The error message returned if the upload job failed.

Success
ErrorCodestring

The error code returned if the upload job failed.

200
CompleteTimestring

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
JobIdstring

The ID of the upload job.

3829500c0fef429fa4ec1680b122d***
UserDatastring

The user data. The value is a JSON string.

{"MessageCallback":"{"CallbackURL":"http://example.aliyundoc.com"}", "Extend":"{"localId":"***", "test":"www"}"}
UploadURLstring

The upload URL of the source file.

Note A maximum of 100 URLs can be returned.
http://****.mp4
MediaIdstring

The ID of the uploaded media file.

5014ca70f08171ecbf940764a0fd6***
FileSizestring

The file size. Unit: bytes.

64610

Examples

Sample success responses

JSONformat

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

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

Change history

Change timeSummary of changesOperation
No change history