GetURLUploadInfos -

Usage notes

You can query the information about a URL-based upload job by specifying the upload URL or using the job ID returned when you upload media files. The information includes the status of the upload job, custom configurations, the time when the job was created, and the time when the job was complete.

If the upload fails, you can view the error code and error message. If the upload is successful, you can obtain the video ID.

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	GetURLUploadInfos	The operation that you want to perform. Set the value to GetURLUploadInfos.
JobIds	String	No	86c1925fba0**,7afb201e7fa,2cc4997378**	The one or more IDs of upload jobs. You can obtain the job IDs in the response parameter JobId of the UploadMediaByURL operation. You can specify a maximum of 10 IDs. Separate multiple IDs with commas (,). Note You must set one of the JobIds and the UploadURLs parameters. If you set both the JobIds and UploadURLs parameters, only the value of the JobIds parameter takes effect.
UploadURLs	String	No	http://****.mp4	The one or more upload URLs of the source files. Separate multiple URLs with commas (,). You can specify a maximum of 10 URLs. Note You must encode the URLs before you use the URLs. If a media file is uploaded multiple times, pass the URL of the media file to this parameter only once. You must set one of the JobIds and the UploadURLs parameters. If you set both the JobIds and UploadURLs parameters, only the value of the JobIds parameter takes effect.

Response parameters


Parameter	Type	Example	Description
RequestId	String	25818875-5F78-4AF6-D7393642CA58****	The ID of the request.
NonExists	Array of String	["**1", "**2"]	The job IDs or upload URLs that do not exist.
URLUploadInfoList	Array of UrlUploadJobInfoDTO		The information about URL-based upload jobs. For more information, see the "URLUploadInfo: the information about a URL-based upload job" section of the Basic structures topic.
CreationTime	String	2019-01-01T01:01:01Z	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.
Status	String	SUCCESS	The status of the URL-based upload job. 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.
ErrorMessage	String	error_message	The error message returned.
ErrorCode	String	200	The error code returned.
CompleteTime	String	2019-01-01T01:11:01Z	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.
JobId	String	86c1925fba0****	The ID of the upload job.
UserData	String	{"MessageCallback":"{"CallbackURL":"http://example.aliyundoc.com"}", "Extend":"{"localId":"***", "test":"www"}"}	The custom configurations. The value is a JSON string. For more information, see the "UserData: specifies the custom configurations for media upload" section of the Request parameters topic.
UploadURL	String	http://****.mp4	The upload URL of the source file. Note A maximum of 100 URLs can be returned.
MediaId	String	93ab850b4f6f54b6e91d24d81d4****	The ID of the uploaded media file.
FileSize	String	24	The size of the uploaded media file. Unit: byte.

Examples

Sample requests

http(s)://vod.cn-shanghai.aliyuncs.com/?Action=GetURLUploadInfos
&JobIds=86c1925fba0****,7afb201e7fa****,2cc4997378****
&<Common request parameters>

Sample success responses

XML format

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

<GetURLUploadInfosResponse>
    <RequestId>25818875-5F78-4AF6-D7393642CA58****</RequestId>
    <NonExists>["****1", "****2"]</NonExists>
    <URLUploadInfoList>
      <UrlUploadJobInfoDTO>
        <CreationTime>2019-01-01T01:01:01Z</CreationTime>
        <Status>SUCCESS</Status>
        <ErrorMessage>error_message</ErrorMessage>
        <ErrorCode>200</ErrorCode>
        <CompleteTime>2019-01-01T01:11:01Z</CompleteTime>
        <JobId>86c1925fba0****</JobId>
        <UserData>{"MessageCallback":"{"CallbackURL":"http://example.aliyundoc.com"}", "Extend":"{"localId":"***", "test":"www"}"}</UserData>
        <UploadURL>http://****.mp4</UploadURL>
        <MediaId>93ab850b4f6f54b6e91d24d81d4****</MediaId>
        <FileSize>24</FileSize>
      </UrlUploadJobInfoDTO>
    </URLUploadInfoList>
</GetURLUploadInfosResponse>

JSON format

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

{
  "RequestId" : "25818875-5F78-4AF6-D7393642CA58****",
  "NonExists" : [ "[\"****1\", \"****2\"]" ],
  "URLUploadInfoList" : [ {
    "CreationTime" : "2019-01-01T01:01:01Z",
    "Status" : "SUCCESS",
    "ErrorMessage" : "error_message",
    "ErrorCode" : "200",
    "CompleteTime" : "2019-01-01T01:11:01Z",
    "JobId" : "86c1925fba0****",
    "UserData" : "{\"MessageCallback\":\"{\"CallbackURL\":\"http://example.aliyundoc.com\"}\", \"Extend\":\"{\"localId\":\"***\", \"test\":\"www\"}\"}",
    "UploadURL" : "http://****.mp4",
    "MediaId" : "93ab850b4f6f54b6e91d24d81d4****",
    "FileSize" : "24"
  } ]
}

Error codes

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