GetUploadDetails -

Usage notes

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.

QPS limit

You can call this operation up to 100 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation. For more information, see QPS limits on API operations in ApsaraVideo VOD.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	GetUploadDetails	The operation that you want to perform. Set the value to GetUploadDetails.
MediaIds	String	Yes	61ccbdb06fa83012be4d8083f6**,7d2fbc380b0e08e55f**	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.
MediaType	String	No	video	The type of the media file. Set the value to video, which indicates audio and video files.

Response parameters


Parameter	Type	Example	Description
RequestId	String	9E290613-04F4-47F4-795D30732077****	The ID of the request.
ForbiddenMediaIds	Array of String	7d2fbc380b0e08e55f****	The IDs of the media files that cannot be accessed.
NonExistMediaIds	Array of String	dfsg****	The IDs of the media files that do not exist.
UploadDetails	Array of UploadDetail		The upload details.
Status	String	Uploading	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.
CreationTime	String	2019-04-28T09:42:07Z	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.
UploadSource	String	WebSDK	The method that is used to upload the media file.
UploadIP	String	192.168.0.1	The IP address of the server that uploads the media file.
DeviceModel	String	Chrome	The device model.
ModificationTime	String	2019-04-28T09:43:12Z	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.
CompletionTime	String	2019-04-28T09:45:07Z	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.
MediaId	String	61ccbdb06fa83012be4d8083f6****	The ID of the uploaded audio or video.
UploadSize	Long	346	The upload size. Unit: byte.
UploadRatio	Float	0.038	The upload ratio.
UploadStatus	String	Uploading	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.
Title	String	Upload details of the test file	The title of the media file.
FileSize	Long	46	The size of the uploaded file. Unit: byte.

Examples

Sample requests

http(s)://vod.cn-shanghai.aliyuncs.com/?Action=GetUploadDetails
&MediaIds=61ccbdb06fa83012be4d8083f6****,7d2fbc380b0e08e55f****
&MediaType=video
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<GetUploadDetailsResponse>
    <RequestId>9E290613-04F4-47F4-795D30732077****</RequestId>
    <ForbiddenMediaIds>7d2fbc380b0e08e55f****</ForbiddenMediaIds>
    <NonExistMediaIds>dfsg****</NonExistMediaIds>
    <UploadDetails>
      <UploadDetail>
        <Status>Uploading</Status>
        <CreationTime>2019-04-28T09:42:07Z</CreationTime>
        <UploadSource>WebSDK</UploadSource>
        <UploadIP>192.168.0.1</UploadIP>
        <DeviceModel>Chrome</DeviceModel>
        <ModificationTime>2019-04-28T09:43:12Z</ModificationTime>
        <CompletionTime>2019-04-28T09:45:07Z</CompletionTime>
        <MediaId>61ccbdb06fa83012be4d8083f6****</MediaId>
        <UploadSize>346</UploadSize>
        <UploadRatio>0.038</UploadRatio>
        <UploadStatus>Uploading</UploadStatus>
        <Title>Upload details of the test file</Title>
        <FileSize>46</FileSize>
      </UploadDetail>
    </UploadDetails>
</GetUploadDetailsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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" : "Upload details of the test file",
    "FileSize" : 46
  } ]
}

Error codes

For a list of error codes, visit the API Error Center.

Common errors

The following table describes the common errors that this operation can return.


Error code	Error message	HTTP status code	Description
LimitExceeded.MediaIds	The input parameter 'MediaIds' Exceed the limit.	400	The error message returned because the number of media IDs exceeds 20.