华为云用户手册

请求示例 单媒资ID查询 GET /v1.0/{project_id}/asset/info?asset_id=652c1e4085afeb22fdc256c6757d751b 多媒资ID查询 GET /v1.0/{project_id}/asset/info?asset_id=652c1e4085afeb22fdc256c6757d751b&asset_id=xxxxxx&asset_id=xxxxxx 按时间段查询 GET /v1.0/{project_id}/asset/info?start_time=20170725181000&end_time=20170726181000&page=0&size=20 查询（当前租户下）所有媒资：最近创建的10个，page为默认值0，size为默认值10 GET /v1.0/{project_id}/asset/info 查询（当前租户下）所有媒资：最近创建的第21个到第40个 GET /v1.0/{project_id}/asset/info?page=1&size=20 按分类查询 GET /v1.0/{project_id}/asset/info?category_id=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参数 参数 参数类型 描述 preheating_results Array of PreheatingResult objects 预热任务数组 表5 PreheatingResult 参数 参数类型 描述 url String 媒资URL。 status String 预热任务状态。 取值如下： processing：处理中 succeed：预热完成 failed：预热失败 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token，使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Authorization 否 String 使用AK/SK方式认证时必选，携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选，请求的发生时间。

响应示例 状态码： 200 处理成功返回。 { "preheating_results" : [ { "url" : "https://example.com/asset/9db42f5e08c15edecd99a98da241994a/313bfd52a75f95ff48e8bf02eca2ab20.flv", "status" : "processing" }, { "url" : "https://example.com/asset/9e455adb02295aa123809e8dc7ca51c1/68b1241af3bf58bcde9914626e07f5af.mp4", "status" : "succeed" }, { "url" : "https://example.com/asset/9e455adb02295aa123809e8dc7ca51c1/play_video/68b1241af3bf58bcde9914626e07f5af_H.264_480X270_HEAACV1_300.mp4", "status" : "failed" } ] } 状态码： 400 处理失败返回。 { "error_code" : "VOD.10053", "error_msg" : "The request parameter is illegal, illegal field: {xx}." }

响应示例 状态码： 200 处理成功返回。 { "asset_id" : "41cff636d5b12a51e7eb2838bbf45201", "base_info" : { "title" : "Avatar", "video_name" : " 视频点播 VOD 视频.mp4", "description" : "Avatar, marketed as James Cameron's Avatar, is a 2009 American\nepic science fiction film directed, written, produced, and\nco-edited by James Cameron", "category_id" : -1, "category_name" : "其他", "create_time" : "20190612032250", "last_modified" : "20190613075030", "video_type" : "MP4", "tags" : "test1,test2", "meta_data" : { "pack_type" : null, "codec" : "H.264", "duration" : 131, "duration_ms" : 131000, "video_size" : 4942645, "width" : 1280, "hight" : 720, "height" : 720, "bit_rate" : 173, "frame_rate" : 30 }, "video_url" : "https://355.cdn-vod.huaweicloud.com/asset/41cff636d5b12a51e7eb2838bbf45201/5597e59de70722eaeb9b18c274e249b2.mp4", "sign_url" : "", "cover_info_array" : [ { "cover_url" : "https://355.cdn-vod.huaweicloud.com/asset/41cff636d5b12a51e7eb2838bbf45201/cover/Cover0.jpg" } ] }, "transcode_info" : { "template_group_name" : "system_template_group", "output" : [ { "play_type" : "HLS", "url" : "https://355.cdn-vod.huaweicloud.com/asset/41cff636d5b12a51e7eb2838bbf45201/play_video/index.m3u8", "encrypted" : 0, "meta_data" : { "pack_type" : null, "codec" : "H.264", "duration" : 0, "duration_ms" : 0, "video_size" : 0, "width" : 0, "hight" : 0, "height" : 0, "bit_rate" : 0, "frame_rate" : 0 } }, { "play_type" : "HLS", "url" : "https://355.cdn-vod.huaweicloud.com/asset/41cff636d5b12a51e7eb2838bbf45201/play_video/视频点播VOD 视频_1_854X480_600_0.m3u8", "encrypted" : 0, "quality" : "SD", "meta_data" : { "pack_type" : null, "codec" : "H.264", "duration" : 130, "duration_ms" : 130000, "video_size" : 7976960, "width" : 854, "hight" : 480, "height" : 480, "bit_rate" : 421, "frame_rate" : 30000, "quality" : "SD" } }, { "play_type" : "DASH", "url" : "https://355.cdn-vod.huaweicloud.com/asset/41cff636d5b12a51e7eb2838bbf45201/play_video/index.mpd", "encrypted" : 0, "meta_data" : { "pack_type" : null, "codec" : "H.264", "duration" : 0, "duration_ms" : 0, "video_size" : 0, "width" : 0, "hight" : 0, "height" : 0, "bit_rate" : 0, "frame_rate" : 0 } }, { "play_type" : "DASH", "encrypted" : 0, "quality" : "SD", "meta_data" : { "pack_type" : null, "codec" : "H.264", "duration" : 130, "duration_ms" : 130000, "video_size" : 7976960, "width" : 854, "hight" : 480, "height" : 480, "bit_rate" : 421, "frame_rate" : 30000, "quality" : "SD" } } ], "exec_desc" : "Transcode success", "transcode_status" : "TRANSCODE_SUCCEED" } } 状态码： 403 处理失败返回。 { "error_code" : "VOD.10064", "error_msg" : "Media asset classification does not exist, please check." }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 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 转码生成文件信息。 说明： 仅当转码成功后才能查询到此信息，未转码、正在转码以及转码失败时，无此字段信息。 表5 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 媒资存储参数信息。查询接口，仅媒资为托管时有返回值。 表6 CoverInfo 参数 参数类型 描述 cover_url String 封面文件的下载地址。 表7 SubtitleInfo 参数 参数类型 描述 url String 字幕文件的下载地址 id Integer 字幕文件id type String 字幕文件类型 language String 字幕文件语言种类 表8 File_addr 参数 参数类型 描述 bucket String OBS的bucket名称。 location String 桶所在的区 域名 ， 如“华北-北京四”的区域名为“cn-north-4”，创建的桶所在区域必须和点播服务所在区域保持一致。 object String 文件的存储路径。 表9 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：转码失败 表10 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 视频的元数据信息。 经过视频解析后产生，包括封装格式、大小、分辨率、码率、帧率。 表11 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 帧率（单位：帧每秒）。 取值如下： F RAM ERATE_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 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

URI GET /v1.0/{project_id}/asset/obs/host/task/details 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参考获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 source_bucket 是 String 媒资原始输入存放的桶。 source_object 是 String 媒资原始输入的objectKey。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token，使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Authorization 否 String 使用AK/SK方式认证时必选，携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选，请求的发生时间。

功能介绍 修改媒资文件在OBS的存储模式。 媒资上传默认为标准存储模式，支持转为低频或者归档存储模式。 低频存储可恢复为标准存储或者降级为归档存储。 归档存储仅支持恢复为标准存储，不支持直接转为低频存储。 OBS存储计费注意事项，如下所示： 低频模式最低存储时间为30天，归档模式最低存储时间为90天。未满此时间提前取回或删除媒资文件，仍会按最低存储时间收费。 以低频存储模式为例进行说明，如果存储时间为28天（＜30天），则按照最低存储时间30天计费；如果存储时间为31天（≥30天），则按实际天数计费。 媒资从低频或归档模式恢复成标准模式也会收取媒资取回的费用。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 task_result_array Array of TaskResult objects 修改媒资存储模式任务的下发结果。 表5 TaskResult 参数 参数类型 描述 asset_id String 媒资ID status String 查看修改媒资存储模式的任务是否下发成功。 SUCCEED：成功 FAILED：失败 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token，使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Authorization 否 String 使用AK/SK方式认证时必选，携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选，请求的发生时间。 表3 请求Body参数 参数 是否必选 参数类型 描述 asset_id 是 String 原媒资ID storage_mode 是 String 存储模式。 取值如下： STANDARD：标准存储。 WARM：低频存储。 COLD：归档存储。 restore_mode 否 String 归档恢复方式。 取值如下： TEMP：临时 FOREVER：永久 days 否 Integer 从归档存储临时恢复为标准存储的时间。 取值范围：1-30。单位：天。 restore_tier 否 String 归档恢复选项。 EXPEDITED：快速恢复 STANDARD：标准恢复 默认值：EXPEDITED。

响应示例 状态码： 200 处理成功返回。 { "task_result_array" : [ { "asset_id" : "2305739f855413a84af9e6ad6e2b21be", "status" : "SUCCEED" } ] } 状态码： 400 处理失败返回。 { "error_code" : "VOD.10053", "error_msg" : "The request parameter is illegal, illegal field: {xx}." }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 start_time String 统计起始时间。 interval Integer 统计间隔。 sample_data Array of VodSampleData objects 采样数据数组。从start_time开始，每个间隔对应一个采样数据（其中转码时长单位：min，存储单位：GB）。 表5 VodSampleData 参数 参数类型 描述 storage Float 标准存储空间。 单位：GB。 storage_warm Float 低频存储空间。 单位：GB。 storage_cold Float 归档存储空间。 单位：GB。 transcode Long 转码时长。 单位：分钟。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 200 处理成功返回。 { "start_time" : "20190528000000", "interval" : 3600, "sample_data" : [ { "storage" : 0, "transcode" : 0 } ] } 状态码： 400 处理失败返回。 { "error_code" : "VOD.10053", "error_msg" : "The request parameter is illegal, illegal field: {xx}." }

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token，使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Authorization 否 String 使用AK/SK方式认证时必选，携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选，请求的发生时间。

URI GET /v1.0/{project_id}/asset/vod-statistics 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参考获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 start_time 否 String 起始时间，格式为yyyymmddhhmmss。 end_time 否 String 结束时间，格式为yyyymmddhhmmss。 “start_time”、“end_time”均不存在时，“start_time”取当天零点，“end_time”取当前时间。 “start_time”不存在、“end_time”存在，请求非法。 “start_time”存在、“end_time”不存在，“end_time”取当前时间。 只能查询最近三个月内的数据，且时间跨度不能超过31天。 起始时间和结束时间会自动规整，起始时间规整为指定时间所在的整点时刻，结束时间规整为指定时间所在时间的下一小时整点时刻。 interval 否 Integer 查询粒度间隔。 取值如下： 时间跨度1天：1小时、4小时、8小时，分别对应3600秒、14400秒和28800秒。 时间跨度2~7天：1小时、4小时、8小时、1天，分别对应3600秒、14400秒、28800秒和86400秒。 时间跨度8~31天：4小时、8小时、1天，分别对应14400秒、28800秒和86400秒。 单位：秒。 若不设置，默认取对应时间跨度的最小间隔。

请求示例 发布媒资 POST https://{endpoint}/v1.0/{project_id}/asset/status/publish Content-Type: application/json { "asset_id": [ "f488337c31c8e4622f1590735b134c65", "07ba4d46463355e800c2f42f628f0631" ] }

响应示例 状态码： 200 处理成功返回。 { "asset_info_array" : [ { "asset_id" : "f488337c31c8e4622f1590735b134c65", "status" : "UNCREATED", "description" : "Asset meta download fail, errorCode is VOD.100021010,\nerrorMsg is Internal server communication is abnormal", "base_info" : { "title" : "Avatar test test", "video_name" : "Avatar_480P.mp4", "description" : "Avatar, test", "category_id" : -1, "category_name" : "其他", "create_time" : "20180209024019", "last_modified" : "20180209024019", "video_type" : "MP4", "tags" : "mytags" } }, { "asset_id" : "07ba4d46463355e800c2f42f628f0631", "status" : " UNCREATED", "description" : "no asset" } ] } 状态码： 403 处理失败返回。 { "error_code" : "VOD.10062", "error_msg" : "Media asset or resource does not exist, please check." }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 asset_info_array Array of AssetInfo objects 发布的媒资信息。 表5 AssetInfo 参数 参数类型 描述 asset_id String VOD分配的媒资ID，仅支持查询，不支持修改。 is_multi_transcode Boolean 是否是多转码模式 status String 媒资状态。 取值如下： UNCREATED：未创建（媒资ID不存在 ） DELETED：已删除 CANCELLED：上传取消 SERVER_ERROR：上传失败（点播服务端故障） UPLOAD_FAILED：上传失败（向OBS上传失败） CREATING：创建中 PUBLISHED：已发布 WAITING_TRANSCODE：待发布（转码排队中） TRANSCODING：待发布（转码中） TRANSCODE_FAILED：待发布（转码失败） TRANSCODE_SUCCEED：待发布（转码成功） CREATED：待发布（未转码） NO_ASSET：该媒资不存在 DELETING：正在删除 DELETE_FAILED：删除失败 OBS_CREATING：OBS转存方式创建中 OBS_CREATE_FAILED： OBS转存失败 OBS_CREATE_SUC CES S： OBS转存成功 description String 媒资子状态或描述信息。 对于媒资异常场景，描述具体的异常原因。 对于正常场景，描述媒资的处理信息。 base_info BaseInfo object 媒资基本信息。 play_info_array Array of PlayInfo objects 转码文件的播放信息。 HLS或DASH：此数组的成员个数为n+1，n为转码输出路数。 MP4：此数组的成员个数为n，n为转码输出路数。 表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 PlayInfo 参数 参数类型 描述 play_type String 播放协议类型。 取值如下： hls dash mp4 group_id String 所属转码组Id group_name String 所属转码组名称 url String 播放URL。 encrypted Integer 标记流是否已被加密。 取值如下： 0：表示未加密。 1：表示已被加密。 默认值：0。 meta_data MetaData object 视频的元数据信息。 经过视频解析后产生，包括封装格式、大小、分辨率、码率、帧率。 表11 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 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token，使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Authorization 否 String 使用AK/SK方式认证时必选，携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选，请求的发生时间。 表3 请求Body参数 参数 是否必选 参数类型 描述 asset_id 是 Array of strings VOD分配的媒资ID，仅支持查询，不支持修改。

API流控 视频点播服务设置了API流控限制，避免出现短时间内重复调用API，服务中断的情况。API流控限制说明如表2所示。 表2 API流控限制 接口分类 接口名称 单租户接口流控 （单位：次数/分钟） 接口总体流控 （单位：次数/分钟） 媒资上传 创建媒资：上传方式 获取分段上传授权 确认媒资上传 桶授权 创建媒资：OBS转存方式 1500 12000 创建媒资：OBS托管方式 创建媒资：URL拉取注入 上传检验 100 1000 媒资处理 视频更新 媒资处理 取消媒资转码任务 音频提取 取消提取音频任务 创建审核媒资任务 设置封面 100 1000 媒资管理 删除媒资 媒资发布 媒资发布取消 修改媒资属性 100 1000 查询媒资信息 1500 24000 查询指定媒资的详细信息 查询媒资列表 1500 12000 （即将下线）OBS托管管理 查询托管任务 查询托管任务详情 100 1000 查询托管媒资详情 1500 12000 媒资预热 CDN预热 查询CDN预热 100 1000 媒资分类 创建媒资分类 修改媒资分类 删除媒资分类 查询指定分类信息 100 1000 密钥查询 密钥查询 1500 12000 统计分析 查询CDN统计信息 查询源站统计信息 查询TopN媒资信息 查询域名播放日志 查询媒资日播放统计数据 100 1000 水印模板管理 创建水印模板 修改水印模板 查询水印列表 删除水印模板 确认水印图片上传 100 1000 转码模板管理 创建自定义转码模板 查询转码模板列表 修改转码模板 删除自定义模板 100 1000 转码模板集合管理 创建转码模板组集合 修改转码模板组集合 查询自定义模板组集合 删除转码模板组集合 100 1000 转码产物管理 删除转码产物 100 1000 媒资存储模式管理 修改媒资降冷粒度 修改媒资文件在OBS的存储模式 查询媒资降冷配置 100 1000

基本概念 账号 用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用创建的用户进行日常管理工作。 用户 由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域 指云资源所在的物理位置，同一区域内可用区间内网互通，不同区域间内网不互通。通过在不同地区创建云资源，可以将应用程序设计的更接近特定客户的要求，或满足不同地区的法律或其他要求。 可用区 一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中购买资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。 图1 项目隔离模型

支持跨域请求的接口说明 目前视频点播服务仅以下接口支持浏览器跨域请求，如表1所示。 表1 支持跨域请求接口列表 接口名称 URI 创建媒资：上传方式 /v1.0/{project_id}/asset 确认媒资上传 /v1.0/{project_id}/asset/status/uploaded 上传检验 /v1.0/{project_id}/asset/duplication 查询媒资信息 /v1.0/{project_id}/asset/info （即将下线）查询托管媒资详情 /v1.0/{project_id}/asset/obs/host/task/details 获取分段上传授权 /v1.0/{project_id}/asset/authority

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token，使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Authorization 否 String 使用AK/SK方式认证时必选，携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选，请求的发生时间。 表3 请求Body参数 参数 是否必选 参数类型 描述 id 是 String 水印模板配置id name 是 String 水印模板名称 dx 否 String 水印图片相对输出视频的水平偏移量，默认值是0。 设置方法有两种，建议小数型，整数型可能导致控制台图片无法预览，但不影响转码： 整数型：表示图片起点水平偏移视频顶点的像素值，单位px。取值范围：[0，4096] 小数型：表示图片起点相对于视频分辨率宽的水平偏移比率。取值范围：(0，1)，支持4位小数，如0.9999，超出部分系统自动丢弃。 dy 否 String 水印图片相对输出视频的垂直偏移量，默认值是0。 设置方法有两种，建议小数型，整数型可能导致控制台图片无法预览，但不影响转码： 整数型：表示图片起点垂直偏移视频顶点的像素值，单位px。取值范围：[0，4096] 小数型：表示图片起点相对于视频分辨率高的垂直偏移比率。取值范围：(0，1)，支持4位小数，如0.9999，超出部分系统自动丢弃。 position 否 String 水印的位置，默认TOPRIGHT。 目前包括： TOPRIGHT：右上位置 TOPLEFT：左上位置 BOTTOMRIGHT：右下位置 BOTTOMLEFT：左下位置 width 否 String 水印图片宽，建议小数型，整数型可能导致控制台图片无法预览，但不影响转码。 值有两种形式： 整数型代水印图片宽的像素值，范围[8，4096]，单位px。 小数型代表相对输出视频分辨率宽的比率，范围(0,1)，支持4位小数，如0.9999，超出部分系统自动丢弃。 height 否 String 水印图片高，建议小数型，整数型可能导致控制台图片无法预览，但不影响转码。 值有两种形式： 整数型代表水印图片高的像素值，范围[8，4096]，单位px。 小数型代表相对输出视频分辨率高的比率，范围(0，1)，支持4位小数，如0.9999，超出部分系统自动丢弃。 watermark_type 否 String 水印类型，当前只支持IMAGE（图片水印） image_process 否 String watermark_type设置为IMAGE时有效。 目前包括： ORIGINAL：只做简单缩放，不做其他处理 TRANSPARENT：图片底色透明 GRAYED：彩色图片变灰 timeline_start 否 String 水印开始时间，与"timeline_duration"配合使用。 取值范围:[0, END)。"END"表示视频结束时间。 单位:秒。 timeline_duration 否 String 水印持续时间，与"timeline_start"配合使用。 取值范围:(0,END-开始时间]。"END"表示视频结束时间。 单位:秒。 默认:END。

响应示例 状态码： 200 处理成功返回。 { "total" : 1, "assets" : [ { "asset_id" : "67d1470893419bfcb9663103dd8a66ac", "title" : "video.mp4", "duration" : 60, "duration_ms" : 60000, "size" : 12881945, "category" : "其他", "covers" : [ { "cover_url" : "https://355.cdn-vod.huaweicloud.com/asset/67d1470893419bfcb9663103dd8a66ac/cover/Cover0.jpg" } ], "create_time" : "20190625020756", "asset_status" : "PUBLISHED", "transcode_status" : "TRANSCODE_SUCCEED", "thumbnail_status" : "UN_THUMBNAIL", "review_status" : "UN_REVIEW", "exec_desc" : "asset_exec_desc:Asset meta is\npublished;transcode_exec_desc:Transcode success;", "media_type" : "MP4" } ] } 状态码： 400 处理失败返回。 { "error_code" : "VOD.10053", "error_msg" : "The request parameter is illegal, illegal field: {xx}." }

请求参数 表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 媒资总数 说明： 暂只能统计2万个媒资，若您需要查询具体的媒资总数，请提交工单申请。 assets Array of AssetSummary objects 媒资列表 表5 AssetSummary 参数 参数类型 描述 asset_id String VOD分配的媒资ID，仅支持查询，不支持修改。 title String 媒资标题。长度不超过128个字节，UTF-8编码。 description String 媒资描述。长度不超过1024个字节。 duration Integer 媒资时长。 单位：秒。 duration_ms Long 视频时长，单位毫秒。 size Long 媒资大小。 单位：字节。 original_url String 原始播放url。 category String 媒资分类名称。 covers Array of CoverInfo objects 封面信息。 create_time String 媒资创建时间。 格式为yyyymmddhhmmss。必须是与时区无关的UTC时间。 asset_status String 媒资状态。 取值如下： CREATING：上传中。 FAILED：上传失败。 CREATED：上传成功。 PUBLISHED：已发布。 DELETED：已删除。 transcode_status String 转码状态。 取值如下： UN_TRANSCODE：未转码。 WAITING_TRANSCODE：待转码 TRANSCODING：转码中。 TRANSCODE_SUCCEED：转码成功。 TRANSCODE_FAILED：转码失败。 thumbnail_status String 截图状态。 取值如下： UN_THUMBNAIL：未截图。 THUMBNAILING：截图中。 THUMBNAIL_SUCCEED：截图成功。 THUMBNAIL_FAILED：截图失败。 review_status String 内容审核 状态 取值如下： UN_REVIEW：未审核。 REVIEWING：审核中。 REVIEW_SUSPICIOUS：审核可疑，需要人工复审。 REVIEW_PASSED：审核通过。 REVIEW_FAILED：审核失败。 REVIEW_BLOCKED：已屏蔽。 exec_desc String 媒资的任务执行描述汇总。 示例： asset_exec_desc: upload success，媒资任务执行描述信息。 transcode_exec_desc: transcode success，转码任务执行描述信息。 thumbnail_exec_desc: thumbnail failed，截图任务执行描述信息。 review_exec_desc: review pass，审核任务执行描述信息。 media_type String 音视频文件的格式。 取值如下： 视频文件格式：MP4、TS、MOV、MXF、MPG、FLV、WMV、AVI、M4V、F4V、MPEG、WEBM 音频文件格式：MP3、OGG、WAV、WMA、APE、FLAC、AAC、AC3、MMF、AMR、M4A、M4R、WV、MP2 表6 CoverInfo 参数 参数类型 描述 cover_url String 封面文件的下载地址。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

URI GET /v1.0/{project_id}/asset/list 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参考获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 asset_id 否 Array of strings 媒资ID，最多同时查询10个。 status 否 Array of strings 媒资状态，同时查询多个状态的媒资。 取值如下： CREATING：上传中 FAILED：上传失败 CREATED：上传成功 PUBLISHED：已发布 TRANSCODING：转码中 TRANSCODE_SUCCEED：转码成功 TRANSCODE_FAILED：转码失败 THUMBNAILING：截图中 THUMBNAIL_SUCCEED：截图成功 THUMBNAIL_FAILED：截图失败 UN_REVIEW：未审核 REVIEWING：审核中 REVIEW_SUSPICIOUS ：审核不过，待人工复审 REVIEW_PASSED：审核通过 REVIEW_FAILED：审核任务失败 REVIEW_BLOCKED：已屏蔽 start_time 否 String 起始时间。 格式为yyyymmddhhmmss。必须是与时区无关的UTC时间。 end_time 否 String 结束时间。 格式为yyyymmddhhmmss。必须是与时区无关的UTC时间。 category_id 否 Integer 分类ID。 tags 否 String 媒资标签。 单个标签不超过24个字节， 最多不超过16 个标签。 多个用英文逗号分隔，UTF8编码。 query_string 否 String 在媒资标题、 描述、分类名称中模糊查询的字符串。 media_type 否 Array of strings 音视频文件的格式，支持多格式查询，最多不超过20个。 取值如下： 视频文件格式：MP4、TS、MOV、MXF、MPG、FLV、WMV、AVI、M4V、F4V、MPEG、WEBM 音频文件格式：MP3、OGG、WAV、WMA、APE、FLAC、AAC、AC3、MMF、AMR、M4A、M4R、WV、MP2 page 否 Integer 分页编号。 默认值：0。 size 否 Integer 每页记录数。 取值范围：[1,100]。 默认值：10。

URI GET /v2/{project_id}/asset/template/transcodings 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参考获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 group_id 否 String 模板id is_default 否 Boolean 是否默认模板 offset 否 Integer 偏移量。默认为0。指定group_id时该参数无效。 limit 否 Integer 每页记录数。默认为10，范围[1,100]。指定group_id时该参数无效。 query_string 否 String 按照模板名和描述模糊查询。指定group_id时该参数无效。