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

Retrieves media upload details by media ID, such as upload time, upload ratio, and upload source. Batch retrieval is supported.

Operation description

This operation only supports retrieving upload details of audio and video files.
If audio or video files are uploaded through the ApsaraVideo VOD console, you can use this operation to retrieve information such as the upload ratio. If audio or video files are uploaded by using the upload SDK, only the following versions of the upload SDK support this operation.

Note

Only the server upload SDK supports this operation. The client upload SDK does not support this operation. The server upload SDK version requirements are as follows:

Java upload SDK: version ≥ 1.4.4
C++ upload SDK: version ≥ 1.0.0
PHP upload SDK: version ≥ 1.0.2
Python upload SDK: version ≥ 1.3.0

QPS limit

The single-user QPS limit for this operation is 100 calls per second. If the limit is exceeded, the API call is throttled, which may affect your business. Call this operation appropriately. For more information, see QPS limit.

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 media IDs, which are audio or video IDs (VideoId). Separate multiple IDs with commas (,). A maximum of 20 IDs are supported. You can obtain the IDs by using the following methods: For audio or video files uploaded through the console, log on to the ApsaraVideo VOD console and choose Media Files > Audio/Video to view the audio or video ID. When you call the CreateUploadVideo operation to obtain the upload URL and credential, the video ID is the value of the VideoId response parameter. After the audio or video file is uploaded, you can call the SearchMedia operation to query the video ID, which is the value of the VideoId response parameter.	61ccbdb06fa83012be4d8083f6**,7d2fbc380b0e08e55f**
MediaType	string	No	The media type. Set the value to video (audio/video).	video

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	9E290613-04F4-47F4-795D30732077****
ForbiddenMediaIds	array	The IDs of media files that cannot be accessed.
	string	The IDs of media files that cannot be accessed.	7d2fbc380b0e08e55f****
NonExistMediaIds	array	The IDs of media files that do not exist.
	string	The IDs of media files that do not exist.	dfsg****
UploadDetails	array<object>	The upload details.
	object	The details of the upload.
Status	string	The video status. For the valid values and descriptions of video statuses, see the value list in Status: video status.	Uploading
CreationTime	string	The creation time. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2019-04-28T09:42:07Z
UploadSource	string	The upload source.	WebSDK
UploadIP	string	The upload IP address.	192.168.0.1
DeviceModel	string	The device model.	Chrome
ModificationTime	string	The modification time. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2019-04-28T09:43:12Z
CompletionTime	string	The completion time. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2019-04-28T09:45:07Z
MediaId	string	The ID of the uploaded audio or video file.	61ccbdb06fa83012be4d8083f6****
UploadSize	integer	The upload size. Unit: bytes.	346
UploadRatio	number	The upload ratio.	0.038
UploadStatus	string	The upload task status. For the valid values and descriptions of upload statuses, see the value list in Status: URL upload task status.	Uploading
Title	string	The title.	Test file upload details
FileSize	integer	The file size. Unit: bytes.	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.