查询视频解析任务
功能介绍
查询解析任务的状态和结果。
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/extract-metadata
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目ID。获取方法请参考获取项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
task_id |
否 |
Array |
任务ID。一次最多10个 |
status |
否 |
String |
任务执行状态。 取值如下：
|
start_time |
否 |
String |
起始时间。格式为yyyymmddhhmmss。必须是与时区无关的UTC时间，指定task_id时该参数无效。 |
end_time |
否 |
String |
结束时间。格式为yyyymmddhhmmss。必须是与时区无关的UTC时间，指定task_id时该参数无效。 |
page |
否 |
Integer |
分页编号。查询指定“task_id”时，该参数无效。 默认值：0。 |
size |
否 |
Integer |
每页记录数。查询指定“task_id”时，该参数无效。 取值范围：[1,100]。 默认值：10。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
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方式认证时必选，请求的发生时间。 |
x-language |
否 |
String |
客户端语言 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
total |
Integer |
任务总数 |
tasks |
Array of ExtractTask objects |
任务列表 |
参数 |
参数类型 |
描述 |
|---|---|---|
task_id |
String |
任务ID |
status |
String |
任务状态。 取值如下：
|
create_time |
String |
任务创建时间 |
start_time |
String |
任务启动时间 |
end_time |
String |
任务结束时间 |
error_code |
String |
任务的返回码。 |
description |
String |
错误描述 |
user_data |
String |
用户数据。 |
input |
ObsObjInfo object |
源文件信息 |
output |
ObsObjInfo object |
输出文件信息 |
metadata |
MetaData object |
输出参数 |
参数 |
参数类型 |
描述 |
|---|---|---|
bucket |
String |
OBS的bucket名称。 |
location |
String |
OBS桶所在的区域，且必须与使用的MPC区域保持一致。 |
object |
String |
OBS对象路径，遵守OSS Object定义。
在字幕场景下，字幕文件名称中禁止携带特殊符号，否则会导致转码任务失败，如：[
|
file_name |
String |
文件名
在作为输出文件名时：
|
参数 |
参数类型 |
描述 |
|---|---|---|
size |
Long |
文件大小。 单位：byte。 |
duration_ms |
Double |
视频时长，带小数位显示。 单位：秒。 |
duration |
Long |
视频时长。 单位：秒。 |
format |
String |
文件封装格式。 |
bitrate |
Long |
总码率。 单位：bit/秒 |
video |
Array of VideoInfo objects |
视频流元数据。 |
audio |
Array of AudioInfo objects |
音频流元数据。 |
参数 |
参数类型 |
描述 |
|---|---|---|
width |
Integer |
视频宽度 |
height |
Integer |
视频高度 |
bitrate |
Integer |
视频码率。 单位: kbit/s |
bitrate_bps |
Long |
视频码率。 单位: bit/s |
frame_rate |
Integer |
帧率。 取值范围：0或[5,60]，0表示自适应。 单位：帧每秒。 说明：
若设置的帧率不在取值范围内，则自动调整为0，若设置的帧率高于片源帧率，则自动调整为片源帧率。 |
codec |
String |
视频编码格式 |
参数 |
参数类型 |
描述 |
|---|---|---|
codec |
String |
音频编码格式 |
sample |
Integer |
音频采样率 |
channels |
Integer |
音频信道 |
bitrate |
Integer |
音频码率。 单位: kbit/s |
bitrate_bps |
Long |
音频码率。 单位: bit/s |
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
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" : {
"bucket" : "example-bucket",
"location" : "region01",
"object" : "example-path/input.mp4"
},
"output" : {
"bucket" : "example-bucket",
"location" : "region01",
"object" : "example-path/output",
"file_name" : "video_001.txt"
},
"metadata" : {
"size" : 43231240,
"duration_ms" : 60.186,
"duration" : 60,
"format" : "MP4",
"bitrate" : 5605,
"video" : [ {
"width" : 3824,
"height" : 2152,
"bitrate" : 5481,
"bitrate_bps" : 5613152,
"frame_rate" : 23,
"codec" : "H.265"
} ],
"audio" : [ {
"codec" : "AAC",
"sample" : 48000,
"channels" : 2,
"bitrate" : 124,
"bitrate_bps" : 127992
} ]
}
} ]
}
状态码： 400
查询视频解析任务失败。
{
"error_code" : "MPC.10202",
"error_msg" : "Invalid request parameter."
}
状态码
状态码 |
描述 |
|---|---|
200 |
查询视频解析任务成功。 |
400 |
查询视频解析任务失败。 |
错误码
请参见错误码。
