文档首页 > > API参考> 媒资转码接口> 查询转码任务

查询转码任务

分享
更新时间:2020/10/15 GMT+08:00

功能介绍

查询转码任务状态。

调试

您可以在API Explorer中调试该接口。

URI

GET /v1/{project_id}/transcodings

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

task_id

ARRAY

转码服务接受任务后产生的任务ID。一次最多10个

status

String

任务执行状态。

取值如下:

  • WAITING:等待启动

  • TRANSCODING:转码中

  • SUCCEEDED:转码成功

  • FAILED:转码失败

  • CANCELED:已删除

  • NEED_TO_BE_AUDIT:片源待审核

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。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

x-language

String

客户端语言

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方式认证时必选,请求的发生时间。

响应参数

状态码为 200 时:

表4 响应Body参数

参数

参数类型

描述

task_array

Array of QueryTranscodingsTaskResponse objects

返回任务组

is_truncated

Integer

查询结果是否被截取。

  • 1:表示被截取,即还有结果未被返回,可以通过设置page和size参数继续查询。

  • 0:表示未被截取,即所有结果已被返回。

total

Integer

查询结果的数量。

表5 QueryTranscodingsTaskResponse

参数

参数类型

描述

task_id

String

任务ID。

status

String

任务执行状态。

create_time

String

转码任务启动时间

end_time

String

转码任务结束时间

trans_template_id

Array of integers

转码任务对应的转码模板ID

input

ObsObjInfo object

转码任务对应的源文件信息,包括location、桶名、源文件。

output

ObsObjInfo object

转码任务的输出信息,包含location、桶名、路径。

output_file_name

Array of strings

转码生成的文件名,数组类型,可能包含多个,包含截图文件名。

user_data

String

用户自定义数据。

error_code

String

转码任务的返回码。

description

String

转码任务描述,当转码出现异常时,此字段为异常的原因。

tips

String

转码成功,但音频采样率过低时的提示。

output_url

String

质检文件输出路径

transcode_detail

TranscodeDetail object

转码任务的额外信息。

thumbnail_output

ObsObjInfo object

截图的输出信息,包含location、桶名、路径。

thumbnail_outputname

String

截图压缩包名。

pic_info

Array of PicInfo objects

截图文件信息。

audit_report

AuditReport object

内容质检信息

表6 TranscodeDetail

参数

参数类型

描述

multitask_info

Array of MultiTaskInfo objects

一进多出情况下部分转码失败的情况。

input_file

SourceInfo object

原始片源信息。

表7 MultiTaskInfo

参数

参数类型

描述

template_id

Integer

转码模板ID。

error

ErrorResponse object

错误信息

output_file

SourceInfo object

输出信息

表8 ErrorResponse

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

表9 SourceInfo

参数

参数类型

描述

duration

Integer

片源时长,单位:秒

duration_ms

Long

片源时长,单位:毫秒

format

String

片源格式

size

Long

片源大小

video_info

VideoInfo object

视频信息

audio_info

Array of AudioInfo objects

音频信息

表10 VideoInfo

参数

参数类型

描述

width

Integer

视频宽度

height

Integer

视频高度

bitrate

Integer

视频码率,单位: kbit/s

bitrate_bps

Long

视频码率,单位: bit/s

frame_rate

Integer

帧率。

取值范围:0或[5,60],0表示自适应。

单位:帧每秒。

说明:

若设置的帧率不在取值范围内,则自动调整为0,若设置的帧率高于片源帧率,则自动调整为片源帧率。

codec

String

视频编码格式

dynamic_range

String

片源动态范围类型。

取值如下:

  • SDR

  • HDR10

  • CUVA_HDR

表11 AudioInfo

参数

参数类型

描述

codec

String

音频编码格式

sample

Integer

音频采样率

channels

Integer

音频信道

bitrate

Integer

音频码率,单位: kbit/s

bitrate_bps

Long

音频码率,单位: bit/s

表12 ObsObjInfo

参数

参数类型

描述

bucket

String

OBS的bucket名称。

location

String

输入OBS Bucket所在数据中心(OBS Location)。

object

String

OBS对象路径,遵守OSS Object定义。

  • 当用于指示input时,需要指定到具体对象。

  • 当用于指示output时, 只需指定到转码结果期望存放的路径。

file_name

String

文件名,仅用于转封装指定输出名称。

  • 当指定了此参数时,输出的对象名为object/file_name 。

  • 当不指定此参数时,输出的对象名为object/xxx,其中xxx由MPC指定。

表13 PicInfo

参数

参数类型

描述

pic_name

String

截图文件名。

表14 AuditReport

参数

参数类型

描述

black_position

String

疑似黑边位置信息,参数格式:top:bottom:left:right

状态码为 400 时:

表15 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

GET https://{endpoint}/v1/{project_id}/transcodings?task_id=22123973

响应示例

状态码

状态码

描述

200

查询转码任务成功。

400

查询转码任务失败。

错误码

请参见错误码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问