7.1 删除媒资
功能介绍
删除媒资。
接口约束
正在处理中的媒资不支持删除，包括转码中、审核中、截图中等。
调试
您可以在API Explorer中调试该接口。
URI
DELETE /v1.0/{project_id}/asset
表7-1 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID，获取方法请参考获取项 目ID
表7-2 Query 参数
参数 是否必选 参数类型 描述
asset_id 是 Array 媒资ID，支持一次删除多个媒 资，批量删除时以逗号分隔。
delete_type 否 String 删除类型，当值为origin时只删 除源文件，保留转码后文件。
请求参数
表7-3 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 否 String 用户Token，使用Token鉴权方 式时必选。
通过调用IAM服务获取用户 Token接口获取（响应消息头中 X-Subject-Token的值）。
Authorization 否 String 使用AK/SK方式认证时必选，携 带的鉴权信息。
X-Sdk-Date 否 String 使用AK/SK方式认证时必选，请 求的发生时间。
响应参数
状态码： 200
表7-4 响应 Body 参数
参数 参数类型 描述
delete_result_
array Array of DeleteResult objects
删除媒资任务的处理结果。
表7-5 DeleteResult
参数 参数类型 描述
asset_id String 媒资ID。
status String 删除状态。
取值如下：
● DELETED：已删除。
● FAILED：删除失败。
状态码： 403
表7-6 响应 Body 参数
参数 参数类型 描述
error_code String 错误码。
error_msg String 错误描述。
请求示例
DELETE https://{endpoint}/v1.0/{project_id}/asset?asset_id={asset_id}
响应示例
状态码： 200 处理成功返回。
{ "delete_result_array" : [ {
"asset_id" : "f488337c31c8e4622f1590735b134c65", "status" : "DELETED"
} ] }
状态码： 403 处理失败返回。
{ "error_code" : "VOD.10062",
"error_msg" : "Media asset or resource does not exist, please check."
}
状态码
状态码 描述
200 处理成功返回。
403 处理失败返回。
错误码
请参见错误码。
7.2 媒资发布
功能介绍
将媒资设置为发布状态。支持批量发布。
调试
您可以在API Explorer中调试该接口。
URI
POST /v1.0/{project_id}/asset/status/publish
表7-7 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID，获取方法请参考获取项 目ID
请求参数
表7-8 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 否 String 用户Token，使用Token鉴权方 式时必选。
通过调用IAM服务获取用户 Token接口获取（响应消息头中 X-Subject-Token的值）。
Authorization 否 String 使用AK/SK方式认证时必选，携 带的鉴权信息。
X-Sdk-Date 否 String 使用AK/SK方式认证时必选，请 求的发生时间。
表7-9 请求 Body 参数
参数 是否必选 参数类型 描述
asset_id 是 Array of
strings 媒资ID。
响应参数
状态码： 200
表7-10 响应 Body 参数
参数 参数类型 描述
asset_info_arr
ay Array of AssetInfo objects
发布的媒资信息。
表7-11 AssetInfo
参数 参数类型 描述
asset_id String 媒资ID。
参数 参数类型 描述 status String 媒资状态。
取值如下：
● UNCREATED：未创建（媒资ID不存在 ）
● DELETED：已删除
● CANCELLED：上传取消
● SERVER_ERROR：上传失败（点播服务端故 障）
● UPLOAD_FAILED：上传失败（向OBS上传失 败）
● CREATING：创建中
● PUBLISHED：已发布
● WAITING_TRANSCODE：待发布（转码排队 中）
● TRANSCODING：待发布（转码中）
● TRANSCODE_FAILED：待发布（转码失败）
● TRANSCODE_SUCCEED：待发布（转码成 功）
● CREATED：待发布（未转码）
● NO_ASSET：该媒资不存在
● DELETING：正在删除
● DELETE_FAILED：删除失败
● OBS_CREATING：OBS转存方式创建中
● OBS_CREATE_FAILED： OBS转存失败
● OBS_CREATE_SUCCESS： OBS转存成功 description String 媒资子状态或描述信息。
● 对于媒资异常场景，描述具体的异常原因。
● 对于正常场景，描述媒资的处理信息。
base_info BaseInfo
object 媒资基本信息。
play_info_arra
y Array of PlayInfo objects
转码文件的播放信息。
● HLS或DASH：此数组的成员个数为n+1，n为 转码输出路数。
● MP4：此数组的成员个数为n，n为转码输出路 数。
表7-12 BaseInfo
参数 参数类型 描述
title String 媒资标题。
长度不超过128个字节，UTF8编码。
video_name String 媒资文件名。
description String 媒资描述。
长度不超过1024个字节。
category_id Long 媒资分类id。
category_nam
e String 媒资分类名称。
create_time String 媒资创建时间。
格式为yyyymmddhhmmss。必须是与时区无关 的UTC时间。
last_modified String 媒资最近修改时间。
格式为yyyymmddhhmmss。必须是与时区无关 的UTC时间。
video_type String 音视频文件类型。
取值如下：
● 视频文件：MP4、TS、MOV、MXF、MPG、
FLV、WMV、AVI、M4V、F4V、MPEG、
3GP、ASF、MKV。
● 音频文件：MP3、OGG、WAV、WMA、
APE、FLAC、AAC、AC3、MMF、AMR、
M4A、M4R、WV、MP2。
tags String 媒资标签。
单个标签不超过16个字节，最多不超过16个标 签。
多个用逗号分隔，UTF8编码。
meta_data MetaData
object 视频的元数据信息。
经过视频解析后产生，包括封装格式、大小、分 辨率、码率、帧率。
video_url String 原始视频文件的访问地址。
cover_info_arr
ay Array of CoverInfo objects
封面信息。
subtitle_info Array of SubtitleInfo objects
字幕信息数组
参数 参数类型 描述 source_path File_addr
object 媒资存储参数信息。
output_path File_addr
object 媒资存储参数信息。
表7-13 MetaData
参数 参数类型 描述
codec String 视频编码格式。
取值如下：
● Vorbis
● AAC
● WavPack duration Long 视频时长。
若视频的原时长为非整数，则该字段值为原时长 的向上取整。
video_size Long 视频文件大小。
单位：字节。
width Long 视频宽度（单位：像素）。
● 编码为H.264的取值范围：[32,3840]之间2的 倍数。
● 编码为H.265的取值范围：[320,3840]之间4的 倍数。
参数 参数类型 描述
hight Long 视频高度（单位：像素）。
● 编码为H.264的取值范围：[32,2160]之间2的 倍数 。
● 编码为H.265的取值范围：[240,2160]之间4的 倍数。
bit_rate Long 视频平均码率。
frame_rate Long 帧率（单位：帧每秒）。
取值如下：
● 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 默认值：1。
单位：帧每秒。
quality String 清晰度。
取值如下：
● FULL_HD：超高清
● HD：高清
● SD：标清
● FLUENT：流畅
● AD：自适应
● 2K
● 4K audio_channe
ls Integer 音频的声道数。
表7-14 CoverInfo
参数 参数类型 描述
cover_url String 封面文件的下载地址。
表7-15 SubtitleInfo
参数 参数类型 描述
url String 字幕文件的下载地址
id Integer 字幕文件id
type String 字幕文件类型
language String 字幕文件语言种类
表7-16 File_addr
参数 参数类型 描述
bucket String OBS的bucket名称。
location String 桶所在的区域名， 如“华北-北京四”的区域名 为“cn-north-4”，创建的桶所在区域必须和点 播服务所在区域保持一致。
object String 文件的存储路径。
表7-17 PlayInfo
参数 参数类型 描述
play_type String 播放协议类型。
取值如下：
● hls
● dash
● mp4 url String 播放URL。
encrypted Integer 标记流是否已被加密。
取值如下：
● 0：表示未加密。
● 1：表示已被加密。
默认值：0。
meta_data MetaData
object 视频的元数据信息。
经过视频解析后产生，包括封装格式、大小、分 辨率、码率、帧率。
状态码： 403
表7-18 响应 Body 参数
参数 参数类型 描述
error_code String 错误码。
error_msg String 错误描述。
请求示例
POST https://{endpoint}/v1.0/{project_id}/asset/status/publish
{ "asset_id" : [ "f488337c31c8e4622f1590735b134c65", "07ba4d46463355e800c2f42f628f0631" ] }
响应示例
状态码： 200 处理成功返回。
{ "asset_info_array" : [ {
"asset_id" : "f488337c31c8e4622f1590735b134c65", "status" : "UNCREATED",
"description" : "Asset meta download fail, errorCode is VOD.100021010,\nerrorMag 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" : "其他", "create_time" : "20180209024019", "last_modified" : "20180209024019", "video_type" : "MP4",
"tags" : "mytags"
} }, {
"asset_id" : "07ba4d46463355e800c2f42f628f0631", "status" : " UNCREATED",
"description" : "no asset"
} ] }
状态码： 403 处理失败返回。
{ "error_code" : "VOD.10062",
"error_msg" : "Media asset or resource does not exist, please check."
}
状态码
状态码 描述
200 处理成功返回。
403 处理失败返回。
错误码
请参见错误码。
7.3 媒资发布取消
功能介绍
将媒资设置为未发布状态。
调试
您可以在API Explorer中调试该接口。
URI
POST /v1.0/{project_id}/asset/status/unpublish
表7-19 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID，获取方法请参考获取项 目ID
请求参数
表7-20 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 否 String 用户Token，使用Token鉴权方 式时必选。
通过调用IAM服务获取用户 Token接口获取（响应消息头中 X-Subject-Token的值）。
Authorization 否 String 使用AK/SK方式认证时必选，携 带的鉴权信息。
X-Sdk-Date 否 String 使用AK/SK方式认证时必选，请 求的发生时间。
表7-21 请求 Body 参数
参数 是否必选 参数类型 描述
asset_id 是 Array of
strings 媒资ID。
响应参数
状态码： 200
表7-22 响应 Body 参数
参数 参数类型 描述
asset_info_arr
ay Array of AssetInfo objects
表7-23 AssetInfo
参数 参数类型 描述
asset_id String 媒资ID。
参数 参数类型 描述 status String 媒资状态。
取值如下：
● UNCREATED：未创建（媒资ID不存在 ）
● DELETED：已删除
● CANCELLED：上传取消
● SERVER_ERROR：上传失败（点播服务端故 障）
● UPLOAD_FAILED：上传失败（向OBS上传失 败）
● CREATING：创建中
● PUBLISHED：已发布
● WAITING_TRANSCODE：待发布（转码排队 中）
● TRANSCODING：待发布（转码中）
● TRANSCODE_FAILED：待发布（转码失败）
● TRANSCODE_SUCCEED：待发布（转码成 功）
● CREATED：待发布（未转码）
● NO_ASSET：该媒资不存在
● DELETING：正在删除
● DELETE_FAILED：删除失败
● OBS_CREATING：OBS转存方式创建中
● OBS_CREATE_FAILED： OBS转存失败
● OBS_CREATE_SUCCESS： OBS转存成功 description String 媒资子状态或描述信息。
● 对于媒资异常场景，描述具体的异常原因。
● 对于正常场景，描述媒资的处理信息。
base_info BaseInfo
object 媒资基本信息。
play_info_arra
y Array of PlayInfo objects
转码文件的播放信息。
● HLS或DASH：此数组的成员个数为n+1，n为 转码输出路数。
● MP4：此数组的成员个数为n，n为转码输出路 数。
表7-24 BaseInfo
参数 参数类型 描述
title String 媒资标题。
长度不超过128个字节，UTF8编码。
video_name String 媒资文件名。
description String 媒资描述。
长度不超过1024个字节。
category_id Long 媒资分类id。
category_nam
e String 媒资分类名称。
create_time String 媒资创建时间。
格式为yyyymmddhhmmss。必须是与时区无关 的UTC时间。
last_modified String 媒资最近修改时间。
格式为yyyymmddhhmmss。必须是与时区无关 的UTC时间。
video_type String 音视频文件类型。
取值如下：
● 视频文件：MP4、TS、MOV、MXF、MPG、
FLV、WMV、AVI、M4V、F4V、MPEG、
3GP、ASF、MKV。
● 音频文件：MP3、OGG、WAV、WMA、
APE、FLAC、AAC、AC3、MMF、AMR、
M4A、M4R、WV、MP2。
tags String 媒资标签。
单个标签不超过16个字节，最多不超过16个标 签。
多个用逗号分隔，UTF8编码。
meta_data MetaData
object 视频的元数据信息。
经过视频解析后产生，包括封装格式、大小、分 辨率、码率、帧率。
video_url String 原始视频文件的访问地址。
cover_info_arr
ay Array of CoverInfo objects
封面信息。
subtitle_info Array of SubtitleInfo objects
字幕信息数组
参数 参数类型 描述 source_path File_addr
object 媒资存储参数信息。
output_path File_addr
object 媒资存储参数信息。
表7-25 MetaData
参数 参数类型 描述
codec String 视频编码格式。
取值如下：
● Vorbis
● AAC
● WavPack duration Long 视频时长。
若视频的原时长为非整数，则该字段值为原时长 的向上取整。
video_size Long 视频文件大小。
单位：字节。
width Long 视频宽度（单位：像素）。
● 编码为H.264的取值范围：[32,3840]之间2的 倍数。
● 编码为H.265的取值范围：[320,3840]之间4的 倍数。
参数 参数类型 描述
hight Long 视频高度（单位：像素）。
● 编码为H.264的取值范围：[32,2160]之间2的 倍数 。
● 编码为H.265的取值范围：[240,2160]之间4的 倍数。
bit_rate Long 视频平均码率。
frame_rate Long 帧率（单位：帧每秒）。
取值如下：
● 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 默认值：1。
单位：帧每秒。
quality String 清晰度。
取值如下：
● FULL_HD：超高清
● HD：高清
● SD：标清
● FLUENT：流畅
● AD：自适应
● 2K
● 4K audio_channe
ls Integer 音频的声道数。
表7-26 CoverInfo
参数 参数类型 描述
cover_url String 封面文件的下载地址。
表7-27 SubtitleInfo
参数 参数类型 描述
url String 字幕文件的下载地址
id Integer 字幕文件id
type String 字幕文件类型
language String 字幕文件语言种类
表7-28 File_addr
参数 参数类型 描述
bucket String OBS的bucket名称。
location String 桶所在的区域名， 如“华北-北京四”的区域名
location String 桶所在的区域名， 如“华北-北京四”的区域名