11.3 取消视频解析任务
11.1 新建视频解析任务
功能介绍
创建视频解析任务，解析视频元数据。
调试
您可以在API Explorer中调试该接口。
URI
POST /v1/{project_id}/extract-metadata 表11-1 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID，获取方法请参考获取项 目ID
API 参考 11 视频解析接口
请求参数
表11-2 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 否 String 用户Token。
通过调用IAM服务获取用户 Token接口获取（响应消息头中 X-Subject-Token的值）。
Authorization 否 String 使用AK/SK方式认证时必选，携 带的鉴权信息。
X-Project_Id 否 String 使用AK/SK方式认证时必选，携 带项目ID信息, 与路径参数中的 项目ID相同。
X-Sdk-Date 否 String 使用AK/SK方式认证时必选，请 求的发生时间。
表11-3 请求 Body 参数
参数 是否必选 参数类型 描述
input 否 ObsObjInfo
object 源文件信息。
output 否 ObsObjInfo
object 输出文件信息。
user_data 否 String 用户自定义数据。
sync 否 Integer 是否同步处理,
● 0：排队处理
● 1：同步处理 默认值：0
表11-4 ObsObjInfo
参数 是否必选 参数类型 描述
bucket 是 String OBS的bucket名称。
location 是 String OBS桶所在的区域，且必须与使 用的MPC区域保持一致。
参数 是否必选 参数类型 描述
object 是 String OBS对象路径，遵守OSS Object 定义。
file_name 否 String 文件名，仅用于转封装指定输出 名称。
● 当指定了此参数时，输出的 对象名为object/
file_name 。
● 当不指定此参数时，输出的
task_id String 任务ID status String 任务状态 create_time String 任务创建时间 output ObsObjInfo
object 输出文件信息 output_file_na
me String 解析文件名称
description String 任务描述，如当任务异常时，此字段为异常的具 体信息
metadata MetaData
object 视频文件元数据
表11-6 ObsObjInfo
参数 参数类型 描述
bucket String OBS的bucket名称。
API 参考 11 视频解析接口
参数 参数类型 描述
location String OBS桶所在的区域，且必须与使用的MPC区域保 持一致。
object String OBS对象路径，遵守OSS Object定义。
● 当用于指示input时,需要指定到具体对象。
● 当用于指示output时, 只需指定到转码结果期 望存放的路径。
file_name String 文件名，仅用于转封装指定输出名称。
● 当指定了此参数时，输出的对象名为object/
file_name 。
● 当不指定此参数时，输出的对象名为object/
xxx，其中xxx由MPC指定。
表11-7 MetaData
参数 参数类型 描述
size Long 文件大小。单位：byte。
duration_ms Double 视频时长，带小数位显示。单位：秒。
duration Long 视频时长。单位：秒。
format String 文件封装格式。
bitrate Long 总码率。单位：bit/秒 video Array of
VideoInfo objects
视频流元数据。
audio Array of AudioInfo objects
音频流元数据。
表11-8 VideoInfo
参数 参数类型 描述
width Integer 视频宽度 height Integer 视频高度
bitrate Integer 视频码率，单位: kbit/s bitrate_bps Long 视频码率，单位: bit/s
参数 参数类型 描述 frame_rate Integer 帧率。
取值范围：0或[5,60]，0表示自适应。
单位：帧每秒。
说明若设置的帧率不在取值范围内，则自动调整为0，若设
置的帧率高于片源帧率，则自动调整为片源帧率。
codec String 视频编码格式
表11-9 AudioInfo
参数 参数类型 描述
codec String 音频编码格式 sample Integer 音频采样率 channels Integer 音频信道
bitrate Integer 音频码率，单位: kbit/s bitrate_bps Long 音频码率，单位: bit/s
状态码： 400
表11-10 响应 Body 参数
参数 参数类型 描述
error_code String 错误码。
error_msg String 错误描述。
请求示例
POST https://{endpoint}/v1/{project_id}/extract-metadata { "input": {
"bucket": "obs-gxh", "location": "region1", "object": "1/okFLV.flv"
}, "output": {
"bucket": "obs-gxh", "location": "region1", "object": "1/output"
}, "sync": 0 }
API 参考 11 视频解析接口
响应示例
状态码： 400
新建视频解析任务失败。
{ "error_code" : "MPC.10202",
"error_msg" : "Invalid request parameter."
}
状态码
状态码 描述
200 新建视频解析任务成功。
400 新建视频解析任务失败。
错误码
请参见错误码。