华为云用户手册

响应示例 状态码：200 查询截图任务成功。 { "task_array" : [ { "task_id" : 7684, "status" : "SUCCEEDED", "create_time" : 20201118121333, "end_time" : 20201118121336, "input" : { "bucket" : "example-bucket", "location" : "region01", "object" : "example-input.ts" }, "output" : { "bucket" : "example-bucket", "location" : "region01", "object" : "example-output/example-path" }, "thumbnail_info" : [ { "pic_name" : "9.jpg" }, { "pic_name" : "5.jpg" } ] } ], "is_truncated" : 0, "total" : 1 } 状态码：400 查询截图任务失败。 { "error_code" : "MPC.10212", "error_msg" : "Operation failed." }

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 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方式认证时必选，请求的发生时间。 x-language 否 String 客户端语言

URI GET /v1/{project_id}/thumbnails 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 task_id 否 Array of strings 截图服务接受任务后产生的任务ID。一次最多10个 status 否 String 任务状态。 取值如下： WAITING: 等待启动 PRO CES SING：截图中 SUCCEEDED：截图成功 FAILED：截图失败 CANCELED：已删除 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。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 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方式认证时必选，请求的发生时间。 表3 请求Body参数 参数 是否必选 参数类型 描述 dx 否 String 水印图片起点相对输出视频顶点的水平偏移量。 设置方法有如下两种： 整数型：表示图片起点水平偏移视频顶点的像素值，单位px。取值范围：[0，4096] 小数型：表示图片起点相对于视频分辨率宽的水平偏移比率。取值范围：(0，1)，支持4位小数，如0.9999，超出部分系统自动丢弃。 示例：输出视频分辨率宽1920，设置“dx”为“0.1”，“referpos”为“TopRight”（右上角），则水印图片右上角到视频右顶点在水平方向上偏移距离为192。 dy 否 String 水印图片起点相对输出视频顶点的垂直偏移量。 设置方法有如下两种：整数型：表示图片起点垂直偏移视频顶点的像素值，单位px。取值范围：[0，4096] 小数型：表示图片起点相对于视频分辨率高的垂直偏移比率。取值范围：(0，1)，支持4位小数，如0.9999，超出部分系统自动丢弃。 示例：输出视频分辨率高1080，设置“dy”为“0.1”，“referpos”为“TopRight”（右上角），则水印图片右上角到视频右顶点在垂直方向上的偏移距离为108。 referpos 否 String 水印的位置。 取值如下： TopRight：右上角。 TopLeft：左上角。 BottomRight：右下角。 BottomLeft：左下角。 ClockWise：顺时针 AntiClockWise：逆时针 Random：随机跳转 timeline_start 否 String 水印开始时间，与“timeline_duration”配合使用。 取值范围：数字。 单位：秒。 timeline_duration 否 String 水印持续时间，与“timeline_start”配合使用。 取值范围：[数字，ToEND]。“ToEND”表示持续到视频结束。 默认值：ToEND。 random_time_min 否 Float 轮转间隔时间最小值，单位：秒 random_time_max 否 Float 轮转间隔时间最大值，单位：秒 image_process 否 String 图片水印处理方式，type设置为Image时有效。 取值如下： Original：只做简单缩放，不做其他处理。 Grayed：图像灰度化处理。 Transparent：保持原始透明图像的透明化效果。如果原始图像中存在透明区域，这些区域在转码处理后仍将保持透明，允许底层的背景或图像透过这些区域显示出来，从而实现图像与背景的无缝融合。 width 否 String 水印图片宽，值有两种形式： 整数型代水印图片宽的像素值，范围[8，4096]，单位px。 小数型代表相对输出视频分辨率宽的比率，范围(0,1)，支持4位小数，如0.9999，超出部分系统自动丢弃。 height 否 String 水印图片高，值有两种形式： 整数型代表水印图片高的像素值，范围[8，4096]，单位px。 小数型代表相对输出视频分辨率高的比率，范围(0，1)，支持4位小数，如0.9999，超出部分系统自动丢弃。 base 否 String 水印叠加母体 取值如下： input ：水印叠加在输入片源上，转码输出视频中的水印实际大小按视频图像的大小进行等比例缩放。 output ：水印叠加在转码输出文件上，转码输出视频中的水印实际大小不会随着视频图像的大小进行等比例缩放。 template_id 否 Integer 水印模板ID template_name 否 String 水印模板名称，最大支持64个字符。 type 否 String 水印类型，当前只支持Image（图片水印）。后续根据需求再支持Text（文字水印）。

请求示例 更新自定义水印模板。 PUT https://{endpoint}/v1/{project_id}/template/watermark { "template_name" : "watermark_1920*1080_10*10_ BottomLeft", "type" : "Image", "image_process" : "Grayed", "width" : "1920", "height" : "1080", "dx" : "0.1", "dy" : "0.1", "referpos" : "BottomLeft", "timeline_start" : "6", "timeline_duration" : "100" }

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 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方式认证时必选，请求的发生时间。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 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方式认证时必选，请求的发生时间。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 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方式认证时必选，请求的发生时间。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 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方式认证时必选，请求的发生时间。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 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方式认证时必选，请求的发生时间。 表3 请求Body参数 参数 是否必选 参数类型 描述 bucket 是 String 桶名 operation 是 String 操作标记 取值范围为 [0,1] 0：表示取消授权 1：表示授权

响应示例 状态码：200 查询视频解析任务成功。 { "total" : 1, "tasks" : [ { "task_id" : 7967, "status" : "SUCCEED", "create_time" : 20201119103821, "start_time" : 20201119103822, "end_time" : 20201119103827, "description" : "The task has completed.", "input" : { "bucket" : "example-bucket", "location" : "region01", "object" : "example-path/input.mp4" }, "output" : { "bucket" : "example-bucket", "location" : "region01", "object" : "example-path/output", "file_name" : "video_001.txt" }, "metadata" : { "size" : 43231240, "duration_ms" : 60.186, "duration" : 60, "format" : "MP4", "bitrate" : 5605, "video" : [ { "width" : 3824, "height" : 2152, "bitrate" : 5481, "bitrate_bps" : 5613152, "frame_rate" : 23, "codec" : "H.265" } ], "audio" : [ { "codec" : "AAC", "sample" : 48000, "channels" : 2, "bitrate" : 124, "bitrate_bps" : 127992 } ] } } ] } 状态码：400 查询视频解析任务失败。 { "error_code" : "MPC.10202", "error_msg" : "Invalid request parameter." }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 total Integer 任务总数 tasks Array of ExtractTask objects 任务列表 表5 ExtractTask 参数 参数类型 描述 task_id String 任务ID status String 任务状态。 取值如下： INIT：初始状态。 WAITING：等待启动。 PROCESSING：处理中。 SUCCEED：处理成功。 FAILED：处理失败。 CANCELED：已取消。 create_time String 任务创建时间 start_time String 任务启动时间 end_time String 任务结束时间 error_code String 任务的返回码。 description String 错误描述 user_data String 用户数据。 input ObsObjInfo object 源文件信息 output ObsObjInfo object 输出文件信息 metadata MetaData object 输出参数 表6 ObsObjInfo 参数 参数类型 描述 bucket String OBS的bucket名称。 location String OBS桶所在的区域，且必须与使用的MPC区域保持一致。 object String OBS对象路径，遵守OSS Object定义。 当用于指示input时，需要指定到具体对象。 当用于指示output时，只需指定到转码结果期望存放的路径。 在字幕场景下，字幕文件名称中禁止携带特殊符号，否则会导致转码任务失败，如：[ 正确示例: demo.srt 错误示例: [demo.srt file_name String 文件名，文件名长度不能超过180个字符。 当指定了此参数时，输出的对象名为object/file_name。 当不指定此参数时，输出的对象名为object/xxx，其中xxx由MPC指定。 在作为输出文件名时： 在转封装场景有效，需要指定输出文件名称 在转码场景下，如果需要指定输出的文件名称，请使用output_filenames参数 在解析场景有效，解析场景如果指定文件名，则将解析参数写入指定文件名，通过查询接口响应json数据获取文件元数据信息 在截图场景无效 在转动图场景无效 输出文件为HLS格式时，文件名称不能命名为index，示例：index.m3u8，否则会导致播放失败。 表7 MetaData 参数 参数类型 描述 size Long 文件大小。 单位：byte。 duration_ms Double 视频时长，带小数位显示。 单位：秒。 duration Long 视频时长。 单位：秒。 format String 文件封装格式。 md5 String 视频的 md5 值。 bitrate Long 总码率。 单位：bit/秒 video Array of VideoInfo objects 视频流元数据。 audio Array of AudioInfo objects 音频流元数据。 表8 VideoInfo 参数 参数类型 描述 width Integer 视频宽度 height Integer 视频高度 bitrate Integer 视频码率。 单位: kbit/s 说明： 视频解析接口2024年8月7日做了如下变更： 变更前：视频解析任务，如果为同步解析，即sync参数配置为1时，解析响应VideoInfo中的参数bitrate单位实际为bit/s。 变更后：视频解析任务同步解析响应VideoInfo中的参数bitrate单位变更为kbit/s。 上述更新，可能会影响历史用户的转码业务判断，请关注并及时调整业务。 bitrate_bps Long 视频码率。 单位: bit/s frame_rate Integer 帧率。 取值范围：0或[5,60]，0表示自适应。 单位：帧每秒。 说明： 若设置的帧率不在取值范围内，则自动调整为0，若设置的帧率高于片源帧率，则自动调整为片源帧率。 codec String 视频编码格式 duration String 视频流时长，单位：秒 duration_ms String 视频流时长，单位：毫秒 rotate Float 视频拍摄时的选择角度，单位：度。 表9 AudioInfo 参数 参数类型 描述 codec String 音频编码格式 sample Integer 音频采样率 channels Integer 音频信道 bitrate Integer 音频码率。 单位: kbit/s bitrate_bps Long 音频码率。 单位: bit/s duration String 音频流时长，单位：秒 duration_ms String 音频流时长，单位：毫秒 状态码：400 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 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方式认证时必选，请求的发生时间。 x-language 否 String 客户端语言

URI GET /v1/{project_id}/extract-metadata 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 task_id 否 Array of strings 任务ID。一次最多10个 status 否 String 任务执行状态。 取值如下： INIT：初始状态 WAITING：等待启动 PREPROCESSING：处理中 SUCCEED：处理成功 FAILED：处理失败 CANCELED：已取消 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。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 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方式认证时必选，请求的发生时间。 表3 请求Body参数 参数 是否必选 参数类型 描述 notifications 是 Array of Notification objects 事件通知模板信息 表4 Notification 参数 是否必选 参数类型 描述 event_name 否 String 消息事件的名称 status 否 String 事件通知模板选中状态 topic 否 String 事件通知主题的URN msg_type 否 Integer 订阅消息类型

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 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方式认证时必选，请求的发生时间。 表3 请求Body参数 参数 是否必选 参数类型 描述 input 否 ObsObjInfo object 源文件信息。 说明： 在转动图、同步解析、同步截图等场景，暂不支持m3u8格式的视频。 output 否 ObsObjInfo object 输出文件信息。 user_data 否 String 用户自定义数据。 output_param 否 RemuxOutputParam object 输出参数。 表4 ObsObjInfo 参数 是否必选 参数类型 描述 bucket 是 String OBS的bucket名称。 location 是 String OBS桶所在的区域，且必须与使用的MPC区域保持一致。 object 是 String OBS对象路径，遵守OSS Object定义。 当用于指示input时，需要指定到具体对象。 当用于指示output时，只需指定到转码结果期望存放的路径。 在字幕场景下，字幕文件名称中禁止携带特殊符号，否则会导致转码任务失败，如：[ 正确示例: demo.srt 错误示例: [demo.srt file_name 否 String 文件名，文件名长度不能超过180个字符。 当指定了此参数时，输出的对象名为object/file_name。 当不指定此参数时，输出的对象名为object/xxx，其中xxx由MPC指定。 在作为输出文件名时： 在转封装场景有效，需要指定输出文件名称 在转码场景下，如果需要指定输出的文件名称，请使用output_filenames参数 在解析场景有效，解析场景如果指定文件名，则将解析参数写入指定文件名，通过查询接口响应json数据获取文件元数据信息 在截图场景无效 在转动图场景无效 输出文件为HLS格式时，文件名称不能命名为index，示例：index.m3u8，否则会导致播放失败。 表5 RemuxOutputParam 参数 是否必选 参数类型 描述 format 否 String 输出格式。取值范围： HLS MP4 segment_duration 否 Integer 分片时长，仅当“format”为“HLS”时有效。 参考取值范围：[2，10]。 默认值： 5。 单位：秒。 说明： 若设置的分片时长不在取值范围内，则自动调整为5。 remove_meta 否 Boolean 输出媒体是否去除片源的中metadata自定义信息。默认值：false

请求示例 创建转封装任务，转换音视频文件的格式，但不改变其分辨率和码率。 POST https://{endpoint}/v1/{project_id}/remux { "input" : { "bucket" : "example-bucket", "location" : "region01", "object" : "example-path/input.flv" }, "output" : { "bucket" : "example-bucket", "location" : "region01", "object" : "example-path/output", "file_name" : "test.m3u8" }, "output_param" : { "format" : "HLS", "segment_duration" : 7 } }

操作步骤 获取用户Token，用于MPC接口调用时的认证鉴权。 在“我的凭证”页面获取username、password、domainname、projectname，调用如下接口 获取Token 。详细信息请参见构造请求。 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "********", //用户名。 "password": "********", //用户登录密码。 "domain": { "name": "domainname" //用户所属的账号名称。 } } } }, "scope": { "project": { "name": "*******" //项目名称。 } } } } 如图1所示，红框中的信息为获取用户Token。 图1 获取用户Token 创建截图任务。 选择POST请求方法并输入URI。 https://{endpoint}/v1/{project_id}/thumbnails 请求消息头中增加“X-Auth-Token”，值设置为步骤1中获取的用户Token。 Request Body中传入参数如下： { "input": { "bucket": "example-bucket", "location": "region01", "object": "/mpc/input/sample.MP4" }, "output": { "bucket": "example-bucket", "location": "region01", "object": "/mpc/output/ "}, "tar": 1, "thumbnail_para": { "type":"DOTS", "dots":[2,4,6,8,10], "format":0, "aspect_ratio":1, "max_length":480 } } 请求响应成功后，返回截图任务ID。 { "task_id": "2081" } 查询视频截图执行情况。 选择GET请求方法并输入URI。 https://{endpoint}/v1/{project_id}/thumbnails?task_id=2081 请求消息头中增加“X-Auth-Token”，值设置为步骤1中获取的用户Token。 请求响应成功后，返回视频截图的详情信息。

响应示例 状态码：200 查询水印模板成功。 { "total" : 1, "templates" : [ { "dx" : 0.1, "dy" : 0.1, "referpos" : "TopRight", "timeline_start" : 0, "timeline_duration" : "ToEND", "image_process" : "Original", "width" : 0.1, "height" : 0.1, "base" : "input", "template_id" : 2743, "template_name" : "createWatermarkTemplate1xYcdyUz", "type" : "Image" } ] } 状态码：403 查询水印模板失败。 { "error_code" : "MPC.10202", "error_msg" : "Invalid request parameter." }

URI GET /v1/{project_id}/template/watermark 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 template_id 否 Array of integers 水印模板ID，最多10个 page 否 Integer 分页编号。查询指定“task_id”时，该参数无效。 默认值：0。 size 否 Integer 每页记录数。取值范围：[1,100]，指定template_id时该参数无效

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 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参数 参数 参数类型 描述 total Integer 水印模板总数。 templates Array of WatermarkTemplate objects 水印模板 表5 WatermarkTemplate 参数 参数类型 描述 dx String 水印图片起点相对输出视频顶点的水平偏移量。 设置方法有如下两种： 整数型：表示图片起点水平偏移视频顶点的像素值，单位px。取值范围：[0，4096] 小数型：表示图片起点相对于视频分辨率宽的水平偏移比率。取值范围：(0，1)，支持4位小数，如0.9999，超出部分系统自动丢弃。 示例：输出视频分辨率宽1920，设置“dx”为“0.1”，“referpos”为“TopRight”（右上角），则水印图片右上角到视频右顶点在水平方向上偏移距离为192。 dy String 水印图片起点相对输出视频顶点的垂直偏移量。 设置方法有如下两种：整数型：表示图片起点垂直偏移视频顶点的像素值，单位px。取值范围：[0，4096] 小数型：表示图片起点相对于视频分辨率高的垂直偏移比率。取值范围：(0，1)，支持4位小数，如0.9999，超出部分系统自动丢弃。 示例：输出视频分辨率高1080，设置“dy”为“0.1”，“referpos”为“TopRight”（右上角），则水印图片右上角到视频右顶点在垂直方向上的偏移距离为108。 referpos String 水印的位置。 取值如下： TopRight：右上角。 TopLeft：左上角。 BottomRight：右下角。 BottomLeft：左下角。 ClockWise：顺时针 AntiClockWise：逆时针 Random：随机跳转 timeline_start String 水印开始时间，与“timeline_duration”配合使用。 取值范围：数字。 单位：秒。 timeline_duration String 水印持续时间，与“timeline_start”配合使用。 取值范围：[数字，ToEND]。“ToEND”表示持续到视频结束。 默认值：ToEND。 random_time_min Float 轮转间隔时间最小值，单位：秒 random_time_max Float 轮转间隔时间最大值，单位：秒 image_process String 图片水印处理方式，type设置为Image时有效。 取值如下： Original：只做简单缩放，不做其他处理。 Grayed：图像灰度化处理。 Transparent：保持原始透明图像的透明化效果。如果原始图像中存在透明区域，这些区域在转码处理后仍将保持透明，允许底层的背景或图像透过这些区域显示出来，从而实现图像与背景的无缝融合。 width String 水印图片宽，值有两种形式： 整数型代水印图片宽的像素值，范围[8，4096]，单位px。 小数型代表相对输出视频分辨率宽的比率，范围(0,1)，支持4位小数，如0.9999，超出部分系统自动丢弃。 height String 水印图片高，值有两种形式： 整数型代表水印图片高的像素值，范围[8，4096]，单位px。 小数型代表相对输出视频分辨率高的比率，范围(0，1)，支持4位小数，如0.9999，超出部分系统自动丢弃。 base String 水印叠加母体 取值如下： input ：水印叠加在输入片源上，转码输出视频中的水印实际大小按视频图像的大小进行等比例缩放。 output ：水印叠加在转码输出文件上，转码输出视频中的水印实际大小不会随着视频图像的大小进行等比例缩放。 template_id Integer 水印模板ID template_name String 水印模板名称，最大支持64个字符。 type String 水印类型，当前只支持Image（图片水印）。后续根据需求再支持Text（文字水印）。 状态码：403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 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方式认证时必选，请求的发生时间。

响应参数 状态码：202 表6 响应Body参数 参数 参数类型 描述 task_id String 任务ID。 status String 任务状态 create_time String 任务创建时间 output ObsObjInfo object 输出文件信息 output_file_name String 截图文件名称 thumbnail_time String 指定的截图时间点 description String 截图任务描述，当截图出现异常时，此字段为异常的原因 表7 ObsObjInfo 参数 参数类型 描述 bucket String OBS的bucket名称。 location String OBS桶所在的区域，且必须与使用的MPC区域保持一致。 object String OBS对象路径，遵守OSS Object定义。 当用于指示input时，需要指定到具体对象。 当用于指示output时，只需指定到转码结果期望存放的路径。 在字幕场景下，字幕文件名称中禁止携带特殊符号，否则会导致转码任务失败，如：[ 正确示例: demo.srt 错误示例: [demo.srt file_name String 文件名，文件名长度不能超过180个字符。 当指定了此参数时，输出的对象名为object/file_name。 当不指定此参数时，输出的对象名为object/xxx，其中xxx由MPC指定。 在作为输出文件名时： 在转封装场景有效，需要指定输出文件名称 在转码场景下，如果需要指定输出的文件名称，请使用output_filenames参数 在解析场景有效，解析场景如果指定文件名，则将解析参数写入指定文件名，通过查询接口响应json数据获取文件元数据信息 在截图场景无效 在转动图场景无效 输出文件为HLS格式时，文件名称不能命名为index，示例：index.m3u8，否则会导致播放失败。 状态码：400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码：202 新建截图任务成功。 新建异步截图任务成功。 { "task_id" : "100211" } 新建同步截图任务成功。 { "task_id" : "100212", "status" : "FINISHED", "create_time" : "20231201020412", "output" : { "bucket" : "bucket-demo", "location" : "cn-north-4", "object" : "output/demo_object", "file_name" : "" }, "output_file_name" : "H_270.png", "thumbnail_time" : "30", "description" : "任务处理成功。" } 状态码：400 新建截图任务失败。 { "error_code" : "MPC.10202", "error_msg" : "Invalid request parameter" }

请求示例 新建异步截图任务，视频截图将从首帧开始，按设置的时间间隔截图，最后截取末帧。 POST https://{endpoint}/v1/{project_id}/thumbnails { "input" : { "bucket" : "example-bucket", "location" : "region01", "object" : "example-path/input.mp4" }, "output" : { "bucket" : "example-bucket", "location" : "region01", "object" : "example-path/output" }, "tar" : 1, "thumbnail_para" : { "time" : 2, "format" : 1, "max_length" : 480 }, "sync" : 0 } 新建同步截图任务（将sync设置为1），视频截图将从首帧开始，按设置的时间间隔截图，最后截取末帧。 POST https://{endpoint}/v1/{project_id}/thumbnails { "input" : { "bucket" : "example-bucket", "location" : "region01", "object" : "example-path/input.mp4" }, "output" : { "bucket" : "example-bucket", "location" : "region01", "object" : "example-path/output" }, "tar" : 1, "thumbnail_para" : { "time" : 2, "format" : 1, "max_length" : 480 }, "sync" : 1 }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 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方式认证时必选，请求的发生时间。 表3 请求Body参数 参数 是否必选 参数类型 描述 input 是 ObsObjInfo object 源文件地址。 output 是 ObsObjInfo object 输出地址。 user_data 否 String 用户自定义数据。 thumbnail_para 是 ThumbnailPara object 截图参数 tar 否 Integer 是否压缩抽帧图片生成tar包。 取值如下： 0：压缩。 1：不压缩 默认值：1 sync 否 Integer 是否同步处理，同步处理是指不下载全部文件，快速定位到截图位置进行截图。 取值如下： 0：排队处理，异步截图。 1：同步处理，同步截图，暂只支持按时间点截单张图。 默认值：0 original_dir 否 Integer 是否使用原始输出目录。 取值如下： 0：不使用原始输出目录，下发的输出目录后面追加随机目录，防止截图文件outputUri相同被覆盖。 1：使用原始输出目录。 默认值：0 表4 ObsObjInfo 参数 是否必选 参数类型 描述 bucket 是 String OBS的bucket名称。 location 是 String OBS桶所在的区域，且必须与使用的MPC区域保持一致。 object 是 String OBS对象路径，遵守OSS Object定义。 当用于指示input时，需要指定到具体对象。 当用于指示output时，只需指定到转码结果期望存放的路径。 在字幕场景下，字幕文件名称中禁止携带特殊符号，否则会导致转码任务失败，如：[ 正确示例: demo.srt 错误示例: [demo.srt file_name 否 String 文件名，文件名长度不能超过180个字符。 当指定了此参数时，输出的对象名为object/file_name。 当不指定此参数时，输出的对象名为object/xxx，其中xxx由MPC指定。 在作为输出文件名时： 在转封装场景有效，需要指定输出文件名称 在转码场景下，如果需要指定输出的文件名称，请使用output_filenames参数 在解析场景有效，解析场景如果指定文件名，则将解析参数写入指定文件名，通过查询接口响应json数据获取文件元数据信息 在截图场景无效 在转动图场景无效 输出文件为HLS格式时，文件名称不能命名为index，示例：index.m3u8，否则会导致播放失败。 表5 ThumbnailPara 参数 是否必选 参数类型 描述 type 否 String 采样类型。 取值如下： "TIME"：根据时间间隔采样截图。 "DOTS"：指定时间点截图。选择同步截图时，需指定此类型。 "DOTS_MS": 同步截图指定时间点毫秒值。 默认值："TIME" amount 否 Integer 黑点比例大于等于此值认为是黑帧。 threshold 否 Integer 像素值小于此值认为是黑点。 time 否 Integer 采样截图的时间间隔值。 默认值：12。 单位：秒 start_time 否 Integer 采样类型为“TIME”模式的开始时间，和“time”配合使用。 默认值：0。 单位：秒。 说明： start_time超过片源时长,不进行抽帧 duration 否 Integer 采样类型为“TIME”模式的持续时间，和“time”、“start_time”配合使用，表示从视频文件的第“start_time”开始，持续时间为“duration”，每间隔“time”生成一张截图。 取值范围：[数字，ToEND]。“ToEND”表示持续到视频结束。 默认值： ToEND。 单位：秒。 说明： “duration”必须大于等0，若设置为0，则截图持续时间从“start_time”到视频结束。 dots 否 Array of integers 指定时间截图的时间点数组 例如输入[1,3,5]，分别截取视频第1秒、第3秒、第5秒位置的图像帧 异步截图：最多支持10个时间点 同步截图时：只支持1个时间点 dots_ms 否 Array of integers 同步截图下，指定时间截图的时间点数组，单位毫秒 例如输入[1000]，截取视频第1000毫秒位置的图像帧，仅支持一个时间点 output_filename 否 String 截图输出文件名。 如果只抽一张图（即：按DOTS方式，指定1个时间点）则按该指定文件名输出图片。 如果抽多张图（即：按DOTS方式指定多个时间点或按TIME间隔截图）则输出图片名在该指定文件名基础上再增加时间点（示例：output_filename_10.jpg）。 如果指定了压缩抽帧图片生成tar包，则tar包按该指定文件名输出。 format 否 Integer 截图文件格式。 取值如下： 1：表示jpg格式 2：表示png格式 仅同步截图支持png格式 width 否 Integer 图片宽度 取值范围： [96,3840] 0：自适应，保持原有宽高 单位：px height 否 Integer 图片高度 取值范围： [96,2160] 0：自适应，保持原有宽高 单位：px max_length 否 Integer 截图最长边的尺寸。宽边尺寸按照该尺寸与原始视频像素等比缩放计算。 参考取值范围：[240,3840] 单位：像素 说明： 该参数和width/height选择使用，以width/height优先，若width/height都不等于0，则图片尺寸按width/height得出；反之，则图片尺寸按max_length 得出;若该参数和width/height都未选择，则按源片源宽高输出截图

请求示例 更新转码模板。 PUT https://{endpoint}/v1/{project_id}/template/transcodings/ { "template_id" : 1001, "template_name" : "MP4_H.264_1920x1080_6000_HEAAC_PVC", "video" : { "codec" : 1, "bitrate" : 6000, "profile" : 3, "level" : 15, "preset" : 3, "max_iframes_interval" : 5, "black_cut" : 0, "bframes_count" : 4, "frame_rate" : 1, "width" : 1920, "height" : 1080 }, "audio" : { "codec" : 1, "sample_rate" : 4, "bitrate" : 128, "channels" : 2 }, "common" : { "PVC" : false, "hls_interval" : 5, "dash_interval" : 5, "pack_type" : 1 } }

操作步骤 获取用户Token，用于MPC接口调用时的认证鉴权。 在“我的凭证”页面获取username、password、domainname、projectname，调用如下接口获取Token。详细信息请参见构造请求。 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "********", //用户名。 "password": "********", //用户登录密码。 "domain": { "name": "domainname" //用户所属的账号名称。 } } } }, "scope": { "project": { "name": "*******" //项目名称。 } } } } 如图1所示，红框中的信息为获取用户Token。 图1 获取用户Token 选择POST请求方法并输入URI。 https://{endpoint}/v1/{project_id}/template/transcodings “mpc.cn-north-4.myhuaweicloud.com”为 媒体处理 服务的终端节点，您可以在区域和终端节点中获取。 调用IAM接口的区域需与调用媒体处理接口的区域一致，如调用“cn-north-4”区域的IAM接口获取用户Token，则该Token仅能用于调用“cn-north-4”区域媒体处理接口的鉴权。 在请求消息头中增加“X-Auth-Token”，值设置为步骤1中获取的用户Token。 在请求消息体中传入如下所示的参数。 { "template_name":"MP4_H.264_1920x1080_6000_HEAAC", "video":{ "codec":1, "bitrate":6000, "profile":3, "level":15, "preset":3, "ref_frames_count":4, "max_iframes_interval":5, "bframes_count":4, "frame_rate":1, "width":1920, "height":1080, "aspect_ratio":0 }, "audio":{ "codec":1, "sample_rate":4, "bitrate":128, "channels":2 }, "common":{ "PVC":0, "hls_interval":5, "dash_interval":5, "pack_type":1 } } 请求响应成功后，返回转码模板ID，状态码为201 Created。 { "template_id":1001 } 若请求失败，返回如下所示的错误码及错误描述。 { "error_code": "MPC.100101", "error_msg": "template error, it's name MP4_H.264_1920x1080_6000_HEAAC is same with template 274764。" }

请求示例 创建视频解析任务，解析视频元数据。 POST https://{endpoint}/v1/{project_id}/extract-metadata { "input" : { "bucket" : "example-bucket", "location" : "region01", "object" : "example-path/input.flv" }, "output" : { "bucket" : "example-bucket", "location" : "region01", "object" : "example-path/output" }, "sync" : 0 }