请求参数 表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参数 参数 是否必选 参数类型 描述 storage_mode_type 否 String 降冷模式。 取值如下： WHOLE：整个媒资粒度降冷，即媒资原始文件、转码后的文件等整个媒资文件，均进行降冷处理。 ORIGIN：原文件粒度降冷，即仅媒资原始视频文件降冷，其转码后的文件等，均不做降冷处理。

URI GET /v1/{project_id}/asset/vod-retrieval 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参考获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 start_time 否 String 开始时间 end_time 否 String 结束时间 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秒。 如果不传，默认取对应时间跨度的最小间隔。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 start_time String 统计起始时间 interval Integer 采样时间间隔 sample_data Array of VodRetrievalData objects 表5 VodRetrievalData 参数 参数类型 描述 retrieval_warm Double 低频存储的媒资恢复为标准存储后的文件大小 retrieval_cold Double 归档存储的媒资按标准取回模式取回的文件大小 retrieval_cold_speed Double 归档存储的媒资按快速取回模式取回的文件大小 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码：200 处理成功返回。 { "start_time" : "20240615000000", "interval" : 3600, "sample_data" : [ { "retrieval_warm" : 1.88, "retrieval_cold" : 2.4, "retrieval_cold_speed" : 1.9 }, { "retrieval_warm" : 3.6, "retrieval_cold" : 4.6, "retrieval_cold_speed" : 3.56 }, { "retrieval_warm" : 2.5, "retrieval_cold" : 0, "retrieval_cold_speed" : 0.08 }, { "retrieval_warm" : 0, "retrieval_cold" : 0, "retrieval_cold_speed" : 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方式认证时必选，请求的发生时间。

请求示例 修改转码模板集合 POST https://{endpoint}/v1.0/{project_id}/asset/template-collection/transcodings Content-Type: application/json { "collection_id": "f9b045e0811c482f9de0d436a5927bb6", "name": "test", "template_group_list": [ "780640dd1d584a6999b104568c358b78", "6a16d8d0161c42caa42b9c148d032871" ] }

请求参数 表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参数 参数 是否必选 参数类型 描述 name 否 String 模板组集合名称 collection_id 是 String 模板组集合ID description 否 String 模板组集合介绍 template_group_list 否 Array of strings 模板组列表

响应示例 状态码：200 处理成功返回。 { "refresh_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}." }

请求参数 表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参数 参数 参数类型 描述 refresh_results Array of RefreshResult objects 刷新任务结果 表5 RefreshResult 参数 参数类型 描述 url String 刷新URL。 status String 刷新任务状态。 取值如下： PRO CES SING：处理中 SUCCEED：刷新完成 FAILED：刷新失败 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Token可通过调用获取用户Token接口获取。 调用本服务API需要项目级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", //IAM用户名 "password": $ADMIN_PASS, //IAM用户密码，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全 "domain": { "name": "domainname" //IAM用户所属账号名 } } } }, "scope": { "project": { "name": "xxxxxxxx" //项目名称 } } } } 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFG....”，则调用接口时将“X-Auth-Token: ABCDEFG....”加到请求消息头即可，如下所示。 1 2 3 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Auth-Token: ABCDEFG.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333。

AK/SK认证 AK/SK签名认证方式仅支持消息体大小在12MB以内，12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK（Access Key ID）：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK（Secret Access Key）：私有访问密钥。与访问密钥ID结合使用，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

响应示例 状态码：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" : "NOASSET", "description" : "no asset" } ] } 状态码：403 处理失败返回。 { "error_code" : "VOD.10062", "error_msg" : "Media asset or resource does not exist, please check." }

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

响应参数 状态码：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_SUCCESS： 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 帧率（单位：帧每秒）。 quality String 清晰度。 取值如下： FULL_HD：超高清 HD：高清 SD：标清 FLUENT：流畅 AD：自适应 2K 4K audio_channels Integer 音频的声道数。 状态码：403 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。