Help Center/ Video On Demand/ API Reference/ Media Asset Upload/ Confirming Media Asset Upload
Updated on 2025-11-26 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Confirming Media Asset Upload

Function

After completing the multipart upload of a media asset, you need to call this API to notify VOD that the media file is fully uploaded and ready for processing.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

POST /v1.0/{project_id}/asset/status/uploaded

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token. This parameter is mandatory when token authentication is used.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Authorization

No

String

Authentication information. This parameter is mandatory for AK/SK authentication.

X-Sdk-Date

No

String

Time when a request is sent. This parameter is mandatory for AK/SK authentication.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

asset_id

Yes

String

Media asset ID assigned by VOD. It can only be queried but cannot be modified.

status

Yes

String

Upload status.

The options include:

  • CREATED: The file has been uploaded.

  • FAILED: The file failed to be uploaded.

  • CANCELLED: The upload has been canceled.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

asset_id

String

Media asset ID assigned by VOD. It can only be queried but cannot be modified.

Status code: 403

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

This example notifies VOD of the upload status of a media file.

POST https://{endpoint}/v1.0/{project_id}/asset/status/uploaded

Content-Type: application/json
{
  "asset_id": "f488337c31c8e4622f1590735b134c65",
  "status": "CREATED"
}

Example Responses

Status code: 200

Returned when the request succeeded.

{
  "asset_id" : "f488337c31c8e4622f1590735b134c65"
}

Status code: 403

Returned when the request failed.

{
  "error_code" : "VOD.10062",
  "error_msg" : "Media asset or resource does not exist, please check."
}

Status Codes

Status Code

Description

200

Returned when the request succeeded.

403

Returned when the request failed.

Error Codes

See Error Codes.

Parent topic: Media Asset Upload