文档首页/ 视频点播 VOD/ API参考/ （即将下线）OBS托管管理/ （即将下线）查询托管任务详情
更新时间：2024-11-20 GMT+08:00
在线调试
CLI示例
查看PDF
分享

（即将下线）查询托管任务详情

功能介绍

查询OBS存量托管任务详情。

接口约束

  • 音视频托管功能即将下线，功能下线后，将不再对新用户开放音视频托管功能。

  • 现网还在用增量托管功能的用户，功能下线后，仍可正常使用。但是建议用户将数据从OBS桶迁移至VOD服务进行存储，不要依赖托管功能，详情请参见【下线公告】华为云视频点播VOD服务音视频托管功能下线。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1.0/{project_id}/asset/obs/host/stock/task/details

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参考获取项目ID
表2 Query参数

参数

是否必选

参数类型

描述

task_id

是

String

任务ID。

page

否

Integer

分页编号，默认为0。

size

否

Integer

每页记录数。

默认10，范围[1,100]

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token，使用Token鉴权方式时必选。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

Authorization

否

String

使用AK/SK方式认证时必选，携带的鉴权信息。

X-Sdk-Date

否

String

使用AK/SK方式认证时必选，请求的发生时间。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

总数。

task_id

String

任务ID。

task_status

String

任务状态。

assets

Array of AssetDetails objects

媒资信息。
表5 AssetDetails

参数

参数类型

描述

asset_id

String

VOD分配的媒资ID，仅支持查询，不支持修改。

asset_status

String

媒资状态。

  • "CREATING"：上传中

  • "FAILED"：上传失败

  • "CREATED"：上传成功

  • "PUBLISHED"：已发布

  • "DELETED"：已删除

transcode_status

String

转码状态。

  • "UN_TRANSCODE"：未转码

  • "WAITING_TRANSCODE"：等待转码，排队中

  • "TRANSCODING"：转码中

  • "TRANSCODE_SUCCEED"：转码成功

  • "TRANSCODE_FAILED"：转码失败

base_info

BaseInfo object

媒资基本信息。

transcode_info

TranscodeInfo object

转码生成文件信息。

说明：

仅当转码成功后才能查询到此信息，未转码、正在转码以及转码失败时，无此字段信息。
表6 BaseInfo

参数

参数类型

描述

title

String

媒资标题。

长度不超过128个字节，UTF8编码。

video_name

String

媒资文件名。

description

String

媒资描述。

长度不超过1024个字节。

category_id

Long

媒资分类id。

category_name

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、WEBM

  • 音频文件：MP3、OGG、WAV、WMA、APE、FLAC、AAC、AC3、MMF、AMR、M4A、M4R、WV、MP2

tags

String

媒资标签。

单个标签不超过24个字节，最多不超过16个标签。

多个用逗号分隔，UTF8编码。

meta_data

MetaData object

视频的元数据信息。

经过视频解析后产生，包括封装格式、大小、分辨率、码率、帧率。

video_url

String

原始视频文件的访问地址。

sign_url

String

原视频文件的OBS临时访问地址。仅调用查询指定媒资的详细信息接口时才返回具体值。

cover_info_array

Array of CoverInfo objects

封面信息。

subtitle_info

Array of SubtitleInfo objects

字幕信息数组

source_path

File_addr object

媒资存储参数信息。查询接口，仅媒资为托管时有返回值。

output_path

File_addr object

媒资存储参数信息。查询接口，仅媒资为托管时有返回值。
表7 CoverInfo

参数

参数类型

描述

cover_url

String

封面文件的下载地址。
表8 SubtitleInfo

参数

参数类型

描述

url

String

字幕文件的下载地址

id

Integer

字幕文件id

type

String

字幕文件类型

language

String

字幕文件语言种类
表9 File_addr

参数

参数类型

描述

bucket

String

OBS的bucket名称。

location

String

桶所在的区域名， 如“华北-北京四”的区域名为“cn-north-4”，创建的桶所在区域必须和点播服务所在区域保持一致。

object

String

文件的存储路径。
表10 TranscodeInfo

参数

参数类型

描述

template_group_name

String

转码模板组名称。

output

Array of Output objects

转码输出数组。

  • HLS或DASH格式：此数组的成员个数为n+1，n为转码输出路数。

  • MP4格式：此数组的成员个数为n，n为转码输出路数。

exec_desc

String

执行情况描述。

transcode_status

String

转码状态。

取值如下：

  • UN_TRANSCODE：未转码

  • WAITING_TRANSCODE：待转码

  • TRANSCODING：转码中

  • TRANSCODE_SUCCEED：转码成功

  • TRANSCODE_FAILED：转码失败
表11 Output

参数

参数类型

描述

play_type

String

协议类型。

取值如下：

  • hls

  • dash

  • mp4

url

String

播放URL。

group_id

String

所属转码组Id

group_name

String

所属转码组名称

encrypted

Integer

标记流是否已被加密。

取值如下：

  • 0：表示未加密。

  • 1：表示已被加密。

quality

String

清晰度。

取值如下：

  • FLUENT：流畅

  • SD：标清

  • HD：高清

  • FULL_HD：超清

meta_data

MetaData object

视频的元数据信息。

经过视频解析后产生，包括封装格式、大小、分辨率、码率、帧率。
表12 MetaData

参数

参数类型

描述

pack_type

String

视频封装格式。

取值如下：

  • MP4

  • TS

  • MOV

  • MXF

  • MPG

  • FLV

  • WMV

  • MP3

  • WMA

  • APE

  • FLAC

  • AAC

  • AC3

  • MMF

  • AMR

  • M4A

  • M4R

  • OGG

  • WAV

  • WV

  • MP2

  • AVI

  • F4V

  • M4V

  • MPEG

  • HLS

  • DASH

codec

String

视频编码格式。

取值如下：

  • MPEG-2

  • MPEG-4

  • H.264

  • H.265

  • WMV

  • Vorbis

  • AAC

  • AC-3

  • AMR

  • APE

  • FLAC

  • MP3

  • MP2

  • WMA

  • PCM

  • ADPCM

  • WavPack

说明：

如果codec返回unknown，说明不支持解析用户当前发送的音视频编码格式。

duration

Long

视频时长。

若视频的原时长为非整数，则该字段值为原时长的向下取整。

若视频的原时长小于1，则该字段值为1。

duration_ms

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的倍数。

height

Long

视频高度（单位：像素）

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_channels

Integer

音频的声道数。

状态码： 403

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

查询存量托管任务详情

GET https://{endpoint}/v1.0/{project_id}/asset/obs/host/stock/task/details?task_id={task_id}

响应示例

状态码： 200

处理成功返回。

{
  "total" : 0,
  "task_id" : "973",
  "task_status" : "SUCCEED",
  "assets" : [ ]
}

状态码： 403

处理失败返回。

{
  "error_code" : "VOD.10053",
  "error_msg" : "The request parameter is illegal, illegal field: {xx}."
}

状态码

状态码

描述

200

处理成功返回。

403

处理失败返回。

错误码

请参见错误码。

相关文档