Call GetUploadDetails to query media file upload details - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Queries the upload details, such as the upload time, upload ratio, and upload source, about one or more media files based on the media IDs.

Operation description

You can call this operation to obtain the upload details only about audio and video files.
If you use the ApsaraVideo VOD console to upload audio and video files, you can call this operation to query information such as the upload ratio. If you use an upload SDK to upload audio and video files, make sure that the version of the upload SDK meets one of the following requirements:
- The version of the upload SDK for Java is 1.4.4 or later.
- The version of the upload SDK for C++ is 1.0.0 or later.
- The version of the upload SDK for PHP is 1.0.2 or later.
- The version of the upload SDK for Python is 1.3.0 or later.
- The version of the upload SDK for JavaScript is 1.4.0 or later.
- The version of the upload SDK for Android is 1.5.0 or later.
- The version of the upload SDK for iOS is 1.5.0 or later.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MediaIds	string	Yes	The ID of the media file, namely, the audio or video ID. You can specify a maximum of 20 IDs. Separate multiple IDs with commas (,). You can use one of the following methods to obtain the audio or video ID: Log on to the ApsaraVideo VOD console. In the left-side navigation pane, choose Media Files > Audio/Video. On the Video and Audio page, you can view the audio or video ID. Use this method if the audio or video file is uploaded by using the ApsaraVideo VOD console. View the value of the VideoId parameter returned by the CreateUploadVideo operation that you called to obtain an upload URL and credential. View the value of the VideoId parameter returned by the SearchMedia operation that you called to query media information after the audio or video file is uploaded.	61ccbdb06fa83012be4d8083f6**,7d2fbc380b0e08e55f**
MediaType	string	No	The type of the media file. Set the value to video, which indicates audio and video files.	video

Response elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The ID of the request.	9E290613-04F4-47F4-795D30732077****
ForbiddenMediaIds	array	The IDs of the media files that cannot be accessed.
	string	The IDs of the media files that cannot be accessed.	7d2fbc380b0e08e55f****
NonExistMediaIds	array	The IDs of the media files that do not exist.
	string	The IDs of the media files that do not exist.	dfsg****
UploadDetails	array<object>	The upload details.
	object	The upload details.
Status	string	The status of the video. 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.	Uploading
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-04-28T09:42:07Z
UploadSource	string	The method that is used to upload the media file.	WebSDK
UploadIP	string	The IP address of the server that uploads the media file.	192.168.0.1
DeviceModel	string	The device model.	Chrome
ModificationTime	string	The time when the information about the media file was updated. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2019-04-28T09:43:12Z
CompletionTime	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-04-28T09:45:07Z
MediaId	string	The ID of the uploaded audio or video.	61ccbdb06fa83012be4d8083f6****
UploadSize	integer	The upload size. Unit: byte.	346
UploadRatio	number	The upload ratio.	0.038
UploadStatus	string	The status of the upload job. For more information about the valid values and value description of the parameter, see the "Status: the status of a URL-based upload job" section of the Basic structures topic.	Uploading
Title	string	The title of the media file.	Test details
FileSize	integer	The size of the uploaded file. Unit: byte.	46

Examples

Success response

JSON format

{
  "RequestId": "9E290613-04F4-47F4-795D30732077****",
  "ForbiddenMediaIds": [
    "7d2fbc380b0e08e55f****"
  ],
  "NonExistMediaIds": [
    "dfsg****"
  ],
  "UploadDetails": [
    {
      "Status": "Uploading",
      "CreationTime": "2019-04-28T09:42:07Z",
      "UploadSource": "WebSDK",
      "UploadIP": "192.168.0.1",
      "DeviceModel": "Chrome",
      "ModificationTime": "2019-04-28T09:43:12Z",
      "CompletionTime": "2019-04-28T09:45:07Z",
      "MediaId": "61ccbdb06fa83012be4d8083f6****",
      "UploadSize": 346,
      "UploadRatio": 0.038,
      "UploadStatus": "Uploading",
      "Title": "Test file upload details",
      "FileSize": 46
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.