状态码
状态码 描述
200 新建视频解析任务成功。
400 新建视频解析任务失败。
错误码
请参见错误码。
11.2 查询视频解析任务
功能介绍
查询解析任务的状态和结果。
调试
您可以在API Explorer中调试该接口。
URI
GET /v1/{project_id}/extract-metadata
表11-11 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID，获取方法请参考获取项 目ID
表11-12 Query 参数
参数 是否必选 参数类型 描述
task_id 否 Array 任务ID。一次最多10个
参数 是否必选 参数类型 描述
status 否 String 任务执行状态。
取值如下：
● INIT：初始状态
● WAITING：等待启动
● PREPROCESSING：处理中
● SUCCEED：处理成功
● FAILED：处理失败
● CANCELED：已取消 start_time 否 String 起始时间。格式为
yyyymmddhhmmss。必须是与 时区无关的UTC时间，指定 task_id时该参数无效。
end_time 否 String 结束时间。格式为
yyyymmddhhmmss。必须是与
X-Auth-Token 否 String 用户Token。
通过调用IAM服务获取用户 Token接口获取（响应消息头中 X-Subject-Token的值）。
Authorization 否 String 使用AK/SK方式认证时必选，携 带的鉴权信息。
X-Project_Id 否 String 使用AK/SK方式认证时必选，携 带项目ID信息, 与路径参数中的 项目ID相同。
API 参考 11 视频解析接口
参数 是否必选 参数类型 描述
X-Sdk-Date 否 String 使用AK/SK方式认证时必选，请 求的发生时间。
x-language 否 String 客户端语言
响应参数
状态码： 200
表11-14 响应 Body 参数
参数 参数类型 描述
total Integer 任务总数 tasks Array of
ExtractTask objects
任务列表
表11-15 ExtractTask
参数 参数类型 描述
task_id String 任务ID status String 任务状态。
取值如下：
● INIT：初始状态。
● WAITING：等待启动。
● PROCESSING：处理中。
● SUCCEED：处理成功。
● FAILED：处理失败。
● CANCELED：已取消。
create_time String 任务创建时间 start_time String 任务启动时间 end_time String 任务结束时间 description String 错误描述 user_data String 用户数据。
input ObsObjInfo
object 源文件信息
参数 参数类型 描述 output ObsObjInfo
object 输出文件信息 metadata MetaData
object 输出参数
表11-16 ObsObjInfo
参数 参数类型 描述
bucket String OBS的bucket名称。
location String OBS桶所在的区域，且必须与使用的MPC区域保 持一致。
object String OBS对象路径，遵守OSS Object定义。
● 当用于指示input时,需要指定到具体对象。
● 当用于指示output时, 只需指定到转码结果期 望存放的路径。
file_name String 文件名，仅用于转封装指定输出名称。
● 当指定了此参数时，输出的对象名为object/
file_name 。
● 当不指定此参数时，输出的对象名为object/
xxx，其中xxx由MPC指定。
表11-17 MetaData
参数 参数类型 描述
size Long 文件大小。单位：byte。
duration_ms Double 视频时长，带小数位显示。单位：秒。
duration Long 视频时长。单位：秒。
format String 文件封装格式。
bitrate Long 总码率。单位：bit/秒 video Array of
VideoInfo objects
视频流元数据。
audio Array of AudioInfo objects
音频流元数据。
API 参考 11 视频解析接口
表11-18 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-19 AudioInfo
参数 参数类型 描述
codec String 音频编码格式 sample Integer 音频采样率 channels Integer 音频信道
bitrate Integer 音频码率，单位: kbit/s bitrate_bps Long 音频码率，单位: bit/s
状态码： 400
表11-20 响应 Body 参数
参数 参数类型 描述
error_code String 错误码。
error_msg String 错误描述。
请求示例
GET https://{endpoint}/v1/{project_id}/extract-metadata?task_id=7967
响应示例
状态码： 200
查询视频解析任务成功。
{ "total" : 1, "tasks" : [ { "task_id" : 7967, "status" : "SUCCEED",
"create_time" : 20201119103821, "start_time" : 20201119103822, "end_time" : 20201119103827,
"description" : "The task has completed.", "input" : { "object" : "out_gamma/extract/", "file_name" : "video_001.txt"
},
{ "error_code" : "MPC.10202",
"error_msg" : "Invalid request parameter."
}
错误码
请参见错误码。