云服务器内容精选

  • 响应参数 状态码: 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 错误描述。
  • 响应示例 状态码: 200 处理成功返回。 { "task_result_array" : [ { "asset_id" : "2305739f855413a84af9e6ad6e2b21be", "status" : "SUCCEED" } ] } 状态码: 400 处理失败返回。 { "error_code" : "VOD.10053", "error_msg" : "The request parameter is illegal, illegal field: {xx}." }
  • 请求参数 表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。
  • 接口约束 请求Body参数的设置要求,如下所示: 参数video_md5、video_name、video_type、cover_type、cover_md5、subtitles必须至少设置一个。 如果更新视频,参数video_md5、video_name、video_type为必填项,不能为空值。 如果更新封面,参数cover_id、cover_type、cover_md5为必填项,不能为空值。 如果上传字幕文件,参数subtitles的id、type和language为必填项,不能为空值。 如果未按照上述要求,正确设置参数,将无法正常返回接口响应消息。
  • 请求示例 更新媒资 PUT https://{endpoint}/v1.0/{project_id}/asset Content-Type: application/json { "asset_id": "f488337c31c8e4622f1590735b134c65", "cover_id": "0", "cover_type": "JPG", "subtitles": [ { "id": 1, "language": "CN", "type": "SRT", "md5": "SqcyFjJZoDZaP8oKIY6rgQ==", "description": "AAAAA" } ] }
  • 响应示例 状态码: 200 处理成功返回。 { "asset_id" : "f488337c31c8e4622f1590735b134c65", "cover_upload_url" : "https://obs.cn-north-4.myhuaweicloud.com:443/obs-vod-1/%7Bproject_id%7D/f488337c31c8e4622f1590735b134c65/cover/Cover0.jpg?AWSAccessKeyId=CBN2JOVSQVVUREU0RCSN&Expires=1518148410&Signature=DVwzU6ejlKlSdAbwFXaSy67JpuA%3D", "subtitle_upload_urls" : [ "https://obs-vod-1.obs.cn-north-4.myhuaweicloud.com:443/14ce1d4437164aba8b364ce15866154e/53a018d2dc53ca07eb5a07a839205c9d/subtitle/1.srt?AWSAccessKeyId=CBN2JOVSQVVUREU0RCSN&Expires=1534760131&Signature=twZPabMSf%2FO%2B2H3mpo3Gsqk1uIo%3D" ] } 状态码: 403 处理失败返回。 { "error_code" : "VOD.10062", "error_msg" : "Media asset or resource does not exist, please check." }
  • 请求参数 表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 VOD分配的媒资ID,仅支持查询,不支持修改。 video_md5 否 String 视频文件MD5值。建议参考《API参考》附录下生成MD5值的媒资上传和更新示例。 video_name 否 String 视频文件名。 文件名后缀为可选。 video_type 否 String 视频文件类型。 取值为MP4、TS、MOV、MXF、MPG、FLV、WMV、AVI、M4V、F4V、MPEG、3GP、ASF、MKV cover_id 否 Integer 封面ID。 取值范围:[0,7]。 当前只支持一张封面,只能设置为0。 cover_type 否 String 封面图片格式类型。 取值如下: JPG PNG cover_md5 否 String 封面文件的MD5值。 subtitles 否 Array of Subtitle objects 字幕文件信息 表4 Subtitle 参数 是否必选 参数类型 描述 id 是 Integer 字幕id。 取值范围:[1,16]。 type 是 String 字幕文件类型,目前暂只支持“SRT”和“VTT”。 language 是 String 字幕语言类型。 name 否 String 字幕文件名称。 md5 否 String 字幕文件的MD5值。 description 否 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参数 参数 是否必选 参数类型 描述 video_type 是 String 转存的音视频文件类型。 取值如下: 视频文件:MP4、TS、MOV、MXF、MPG、FLV、WMV、AVI、M4V、F4V、MPEG、3GP、ASF、MKV、HLS、RMVB、WEBM 音频文件:MP3、OGG、WAV、WMA、APE、FLAC、AAC、AC3、MMF、AMR、M4A、M4R、WV、MP2 若上传格式为音频文件,则不支持转码、添加水印和字幕。 说明: 当video_type选择HLS时,storage_mode(存储模式)需选择存储在租户桶,且输出路径设置为和输入路径在同一个目录。 title 是 String 媒资标题,长度不超过128个字节,UTF-8编码。 description 否 String 视频描述,长度不超过1024个字节。 category_id 否 Integer 媒资分类ID。 您可以调用创建媒资分类接口或在点播控制台的分类设置中创建对应的媒资分类,并获取分类ID。 说明: 若不设置或者设置为-1,则上传的音视频归类到系统预置的“其它”分类中。 tags 否 String 视频标签。 单个标签不超过16个字节,最多不超过16个标签。 多个用逗号分隔,UTF8编码。 auto_publish 否 Integer 是否自动发布。 取值如下: 0:表示不自动发布。 1:表示自动发布。 默认值:1。 template_group_name 否 String 转码模板组名称。 若不为空,则使用指定的转码模板对上传的音视频进行转码,您可以在视频点播控制台配置转码模板,具体请参见《点播服务用户指南》中的“转码设置”。 说明: 若同时设置了“template_group_name”和“workflow_name”字段,则“template_group_name”字段生效。 auto_encrypt 否 Integer 是否自动加密。 取值如下: 0:表示不加密。 1:表示需要加密。 默认值:0。 若设置为需要加密,则必须配置转码模板,且转码的输出格式是HLS。 auto_preheat 否 Integer 是否自动预热到CDN。 取值如下: 0:表示不自动预热。 1:表示自动预热。 默认值:0。 thumbnail 否 Thumbnail object 截图参数 review 否 Review object 媒资审核参数。 说明: 仅“华北-北京一”、“华北-北京四”点播服务支持此功能。 workflow_name 否 String 工作流名称。若不为空,则使用指定的工作流对上传的音视频进行处理,您可以在视频点播控制台配置工作流,具体请参见《点播服务用户指南》中的“工作流设置”。 input 是 File_addr object 媒资存储参数信息。查询接口,仅媒资为托管时有返回值。 storage_mode 否 Integer 存储模式。 取值如下: 0:表示视频拷贝到点播桶。 1:表示视频存储在租户桶。 默认值:0 output_bucket 否 String 输出桶名,“storage_mode”为1时必选。 output_path 否 String 输出路径名,“storage_mode”为1时必选。 表4 Thumbnail 参数 是否必选 参数类型 描述 type 是 String 截图类型。 取值如下: time:每次进行截图的间隔时间。 dots: 按照指定的时间点截图。 quantity: 按照指定张数,根据视频时长等分视频截图。 quantity 否 Integer type取值为quantity时必填。 按照指定张数,根据视频时长等分视频截图。 取值范围:[1,10]之间的整数。 quantity_time 否 Integer type取值为quantity时选填。 按照指定时间间隔取指定张数截图。 取值范围:[0,2147483647]之间的整数。 time 否 Integer 根据时间间隔采样时的时间间隔值。单位:秒。 type取值为time时。 默认值:12 取值范围:[0,100]之间的整数。 dots 否 Array of integers type取值为dots时必填。指定时间截图时的时间点数组。 cover_position 否 Integer 该值表示指定第几张截图作为封面。 默认值:1。 format 否 Integer 截图文件格式。 取值如下: 1:jpg。 默认值:1 。 aspect_ratio 否 Integer 纵横比,图像缩放方式。 取值如下: 0:自适应(保持原有宽高比)。 1:16:9。 默认值:0。 max_length 否 Integer 截图最长边的尺寸。 单位:像素。 宽边尺寸按照该尺寸与原始视频像素等比缩放计算。 默认值:480。 表5 Review 参数 是否必选 参数类型 描述 template_id 是 String 审核模板ID。您可以在视频点播控制台配置审核模板后获取,具体请参见《点播服务用户指南》中的“审核设置”。 说明: 仅“华北-北京一”、“华北-北京四”点播服务支持此功能。 interval 否 Integer 截图检测时间间隔,取值范围为[0,100],该参数在请求参数中忽略。 politics 否 Integer 鉴政内容检测置信度,取值范围为[0,100],该参数在请求参数中忽略。 置信度越高,说明审核结果越可信。未开启或设置为0时,表示未进行此项检测。 terrorism 否 Integer 鉴恐内容的检测置信度,取值范围为[0,100],该参数在请求参数中忽略。 置信度越高,说明审核结果越可信。未开启或设置为0时,表示未进行此项检测。 porn 否 Integer 鉴黄内容的检测置信度,取值范围为[0,100],该参数在请求参数中忽略。 置信度越高,说明审核结果越可信。未开启或设置为0时,表示未进行此项检测。 表6 File_addr 参数 是否必选 参数类型 描述 bucket 是 String OBS的bucket名称。 location 是 String 桶所在的区域名, 如“华北-北京四”的区域名为“cn-north-4”,创建的桶所在区域必须和点播服务所在区域保持一致。 object 是 String 文件的存储路径。
  • 请求示例 转存存储在OBS桶中的HLS视频至点播服务中(ts文件需和m3u8文件在同一目录下) POST https://{endpoint}/v1.0/{project_id}/asset/reproduction Content-Type: application/json { "video_type": "HLS", "title": "tittle", "auto_publish": 1, "input": { "bucket": "bucket_name", "location": "cn-north-4", "object": "test/hls/test_video.m3u8" }, "storage_mode": 1, "output_bucket": "bucket_name", "output_path": "test/hls" } 转存存储在OBS桶中的音视频文件至点播服务中 POST https://{endpoint}/v1.0/{project_id}/asset/reproduction Content-Type: application/json { "input": { "bucket": "bucket", "location": "cn-north-4", "object": "path" }, "title": "title", "description": "des", "category_id": -1, "tags": "test", "video_type": "MP4", "auto_publish": 1, "template_group_name": "tempName" }
  • 请求参数 表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参数 参数 是否必选 参数类型 描述 bucket 是 String OBS桶名称。 operation 是 String 是否进行桶授权。 取值如下: 0:取消授权。 1:授权。
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token,使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Authorization 否 String 使用AK/SK方式认证时必选,携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选,请求的发生时间。
  • 响应示例 状态码: 200 处理成功返回。 [ { "id" : "334", "name" : "电影", "children" : [ { "id" : "335", "name" : "电视", "children" : [ ] } ] } ] 状态码: 400 处理失败返回。 { "error_code" : "VOD.10053", "error_msg" : "The request parameter is illegal, illegal field: {xx}." }
  • 请求示例 创建媒资 POST https://{endpoint}/v1/{project_id}/asset Content-Type: application/json { "title": "Avatar test test", "description": "Avatar, test", "category_id": -1, "tags": "mytags", "video_name": "Avatar_480P.mp4", "video_type": "MP4", "video_md5": "a945d4b3d8fc317190a9332fe856f03d", "cover_type": "JPG", "cover_md5": "a655d4b3d8fc758691a9332fe387f26c", "auto_publish": 0, "subtitles": [ { "id": 1, "language": "CN", "type": "SRT", "md5": "SqcyFjJZoDZaP8oKIY6rgQ==", "description": "AAAAA" } ] }
  • 响应示例 状态码: 200 处理成功返回。 { "asset_id" : "f488337c31c8e4622f1590735b134c65", "video_upload_url" : "https://obs.cn-north-4.myhuaweicloud.com:443/obs-vod-1/%7Bproject_id%7D/f488337c31c8e4622f1590735b134c65/Avatar_480P.mp4?AWSAccessKeyId=CBN2JOVSQVVUREU0RCSN&Expires=1518147618&Signature=kZYh0hEos2VJhjjdHC2zVAHGyXA%3D", "cover_upload_url" : "https://obs.cn-north-4.myhuaweicloud.com:443/obs-vod-1/%7Bproject_id%7D/f488337c31c8e4622f1590735b134c65/cover/Cover0.jpg?AWSAccessKeyId=CBN2JOVSQVVUREU0RCSN&Expires=1518147619&Signature=eVoLA54Qi6cG9vZbS3fuaIw1RDQ%3D", "subtitle_upload_urls" : [ "https://obs-vod-1.obs.cn-north-4.myhuaweicloud.com:443/14ce1d4437164aba8b364ce15866154e/53a018d2dc53ca07eb5a07a839205c9d/subtitle/1.srt?AWSAccessKeyId=CBN2JOVSQVVUREU0RCSN&Expires=1534760131&Signature=twZPabMSf%2FO%2B2H3mpo3Gsqk1uIo%3D" ], "target" : { "bucket" : "obs-vod-1", "location" : "cn-north-4", "object" : "093bb6b6c4fc460ab90a40d8b821dda3/a2053aef99725711dad3e02dc6cd5f89/0a9b70035b78b8a19c6d9e7c2693d93c.mp4" } } 状态码: 403 处理失败返回。 { "error_code" : "VOD.10064", "error_msg" : "Media asset classification does not exist, please check." }
  • 响应参数 状态码: 200 表7 响应Body参数 参数 参数类型 描述 asset_id String 媒体ID video_upload_url String 视频上传URL cover_upload_url String 封面上传地址 subtitle_upload_urls Array of strings 字幕文件上传url数组 target File_addr object 媒资存储参数信息。查询接口,仅媒资为托管时有返回值。 表8 File_addr 参数 参数类型 描述 bucket String OBS的bucket名称。 location String 桶所在的区域名, 如“华北-北京四”的区域名为“cn-north-4”,创建的桶所在区域必须和点播服务所在区域保持一致。 object String 文件的存储路径。 状态码: 403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。