Help Center/ Video On Demand/ API Reference/ Media file management/ Unpublishes the media asset

Updated on 2024-04-30 GMT+08:00

Online Debugging

CLI Examples

View PDF

Unpublishes the media asset

Function

Sets the status of the media asset to unpublished

URI

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

**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	Array of strings	Media asset ID assigned by VOD. This parameter can only be queried but cannot be modified.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
asset_info_array	Array of AssetInfo objects	Media file status set.

**Table 5** AssetInfo
Parameter	Type	Description
asset_id	String	Media asset ID assigned by VOD. This parameter can only be queried but cannot be modified.
is_multi_transcode	Boolean	Whether there are multiple transcoding modes.
status	String	Media file status Possible values are: UNCREATED: The media file ID does not exist. DELETED: The task has been deleted. CANCELLED: The upload has been canceled. SERVER_ERROR: File upload failed due to a VOD server fault. UPLOAD_FAILED: File upload to OBS failed. CREATING: The task is being created. PUBLISHED: The file has been published. WAITING_TRANSCODE: The file is to be published (to be transcoded). TRANSCODING: The file is to be published (being transcoded). TRANSCODE_FAILED: The file is to be published (transcoding failed). TRANSCODE_SUCCEED: The file is to be published (transcoding succeeded). CREATED: The file is to be published (not transcoded). NO_ASSET: The media asset does not exist. DELETING: The file is being deleted. DELETE_FAILED: The deletion failed. OBS_CREATING: The task for dumping data to OBS is being created. OBS_CREATE_FAILED: Data dump to OBS failed. OBS_CREATE_SUCCESS: Data has been dumped to OBS.
description	String	Media file substatus or description Describes the exception cause of an abnormal media file. Describes the processing information of a normal media file.
base_info	BaseInfo object	Basic media file information.
play_info_array	Array of PlayInfo objects	Playback information about the transcoded file HLS or DASH: The number of members in this array is n + 1, where n indicates the number of channels in the output file. MP4: The number of members in this array is n, which indicates the number of channels in the output file.

**Table 6** BaseInfo
Parameter	Type	Description
title	String	Media file title The value is UTF-8-encoded and contains a maximum of 128 characters.
video_name	String	Media asset file name
description	String	Media file description The value contains a maximum of 1024 characters.
category_id	Long	Media asset category ID
category_name	String	Media asset category name
create_time	String	Time when the media file was created The format is yyyymmddhhmmss. The value must be a UTC time irrelevant to the time zone.
last_modified	String	Time when the media file was last modified The format is yyyymmddhhmmss. The value must be a UTC time irrelevant to the time zone.
video_type	String	Audio/Video file type Possible values are: Video files: MP4, TS, MOV, MXF, MPG, FLV, WMV, AVI, M4V, F4V, MPEG, 3GP, ASF, and MKV Audio files: MP3, OGG, WAV, WMA, APE, FLAC, AAC, AC3, MMF, AMR, M4A, M4R, WV, and MP2
tags	String	Media file tag Each tag contains up to 16 characters and up to 16 tags are allowed. Use commas (,) to separate tags. The values are UTF-8-encoded.
meta_data	MetaData object	Video metadata It is generated after video parsing, including the packaging format, size, resolution, bitrate, and frame rate.
video_url	String	URL for accessing the original video file
sign_url	String	Temporary access URL of the original video file in OBS. A specific value is returned only when the API for Querying File Information is called.
cover_info_array	Array of CoverInfo objects	Cover information
subtitle_info	Array of SubtitleInfo objects	Subtitle information array
source_path	File_addr object	Media asset storage parameters.
output_path	File_addr object	Media asset storage parameters.

**Table 7** CoverInfo
Parameter	Type	Description
cover_url	String	URL for downloading the cover file

**Table 8** SubtitleInfo
Parameter	Type	Description
url	String	URL for downloading the subtitle file
id	Integer	Subtitle file ID
type	String	Subtitle file type
language	String	Subtitle file language

**Table 9** File_addr
Parameter	Type	Description
bucket	String	OBS bucket name
location	String	Name of the region where the bucket is located. For example, the region name of CN North-Beijing4 is cn-north-4. The created bucket must be in the region of the VOD service.
object	String	File path

**Table 10** PlayInfo
Parameter	Type	Description
play_type	String	Playback protocol type Possible values are: hls dash mp4
group_id	String	Transcoding group ID.
group_name	String	Transcoding group name.
url	String	Streaming URL
encrypted	Integer	Whether the stream is encrypted Possible values are: 0: not encrypted 1: encrypted Default value: 0
meta_data	MetaData object	Video metadata It is generated after video parsing, including the packaging format, size, resolution, bitrate, and frame rate.

**Table 11** MetaData
Parameter	Type	Description
pack_type	String	Video container format Possible values are: MP4 TS MOV MXF MPG FLV WMV MP3 WMA APE FLAC AAC AC3 MMF AMR M4A M4R OGG WAV WV MP2 AVI F4V M4V MPEG HLS DASH
codec	String	Video encoding format. Options: MPEG-2 MPEG-4 H.264 H.265 WMV Vorbis AAC AC-3 AMR APE FLAC MP3 MP2 WMA PCM ADPCM WavPack NOTE: If unknown is returned for codec, the current audio/video encoding format sent by the user cannot be parsed.
duration	Long	Video duration. If the value of the original video duration is not an integer, the value of this field is rounded up.
video_size	Long	Video file size Unit: byte
width	Long	Video width, in pixels Possible values for H.264: a multiple of 2 between 32 and 3840 Possible values for H.265: a multiple of 4 between 320 and 3840
hight	Long	Video height, in pixels. Possible values for H.264: a multiple of 2 between 32 and 2,160 Possible values for H.265: a multiple of 4 between 240 and 2,160
bit_rate	Long	Average video bitrate
frame_rate	Long	Frame rate, in FPS Possible values are: FRAMERATE_AUTO = 1, FRAMERATE_10 = 2, FRAMERATE_15 = 3, FRAMERATE_2397 = 4, // 23.97 fps FRAMERATE_24 = 5, FRAMERATE_25 = 6, FRAMERATE_2997 = 7, // 29.97 fps FRAMERATE_30 = 8, FRAMERATE_50 = 9, FRAMERATE_60 = 10 The default value is 1. Unit: FPS
quality	String	Definition Possible values are: FULL_HD: ultra-high-definition (UHD) HD: high definition (HD) SD: standard definition (SD) FLUENT: smooth AD: adaptive 2K 4K
audio_channels	Integer	Number of audio channels

Status code: 403

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error description

Example Requests

Unpublishes a media file.

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

{
  "asset_id" : [ "f488337c31c8e4622f1590735b134c65", "07ba4d46463355e800c2f42f628f0631" ]
}

Example Responses

Status code: 200

The information is returned when the request succeeds.

{
  "asset_info_array" : [ {
    "asset_id" : "f488337c31c8e4622f1590735b134c65",
    "status" : "UNCREATED",
    "description" : "Asset meta download fail, errorCode is VOD.100021010,\nerrorMsg is Internal server communication is abnormal",
    "base_info" : {
      "title" : "Avatar test test",
      "video_name" : "Avatar_480P.mp4",
      "description" : "Avatar, test",
      "category_id" : -1,
      "category_name" : "Other",
      "create_time" : "20180209024019",
      "last_modified" : "20180209024019",
      "video_type" : "MP4",
      "tags" : "mytags"
    }
  }, {
    "asset_id" : "07ba4d46463355e800c2f42f628f0631",
    "status" : "NOASSET",
    "description" : "no asset"
  } ]
}

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: Media file management

Previous topic: Publishes the media asset

Next topic: Queries media asset information

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot