Help Center/ Video On Demand/ API Reference/ Uploads media files/ Confirms media asset upload
Updated on 2024-12-04 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Confirms media asset upload

Function

Notifies VOD of the media asset upload status after the media file is uploaded by part, indicating that the media asset has been uploaded.

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 a token.

Authorization

No

String

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

X-Sdk-Date

No

String

Time when the 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. This parameter can only be queried but cannot be modified.

status

Yes

String

Status

Possible values are:

  • CREATED: The file has been created.

  • FAILED: File creation failed.

  • CANCELLED: The creation task 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. This parameter 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

Notifies VOD of the media file upload status.

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

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

Example Responses

Status code: 200

The information is returned when the request succeeds.

{
  "asset_id" : "f488337c31c8e4622f1590735b134c65"
}

Status code: 403

The information is returned when the request fails.

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

Status Codes

Status Code

Description

200

The information is returned when the request succeeds.

403

The information is returned when the request fails.

Error Codes

See Error Codes.

Parent topic: Uploads media files