华为云用户手册

请求示例 更新自定义水印模板。 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" }

请求参数 表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（文字水印）。

请求参数 表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" }

请求示例 新建水印模板，水印模板目前默认支持创建100000个。 POST 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" : "10", "dy" : "10", "referpos" : "BottomLeft", "timeline_start" : "6", "timeline_duration" : "8" }

请求参数 表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（文字水印）。

功能介绍 自定义水印模板，水印模板目前默认支持创建100000个。 在视频内容中嵌入可见的水印，水印有多种应用场景和内容类型，例如:"赞助商或合作伙伴Logo"、"质量或认证标志"等。 水印模板是预设的一系列参数集合，用于定义水印的位置、大小等关键属性。通过使用水印模板，开发者可以简化水印应用的开发流程，实现快速、一致的水印添加效果。 水印模板只适用于图片水印，不适用于文字水印。文字水印请在CreateTranscodingTask - 新建转码任务接口中指定WaterMarks参数。 水印模板仅包含水印的位置、大小属性，不包含水印素材。水印素材需要在提交媒资转码任务时添加。 水印模板可以通过控制台，或调用 CreateWatermarkTemplate - 新建水印模板。

请求示例 新建水印模板，水印模板目前默认支持创建100000个。 POST 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" : "10", "dy" : "10", "referpos" : "BottomLeft", "timeline_start" : "6", "timeline_duration" : "8" }

请求参数 表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（文字水印）。

功能介绍 自定义水印模板，水印模板目前默认支持创建100000个。 在视频内容中嵌入可见的水印，水印有多种应用场景和内容类型，例如:"赞助商或合作伙伴Logo"、"质量或认证标志"等。 水印模板是预设的一系列参数集合，用于定义水印的位置、大小等关键属性。通过使用水印模板，开发者可以简化水印应用的开发流程，实现快速、一致的水印添加效果。 水印模板只适用于图片水印，不适用于文字水印。文字水印请在CreateTranscodingTask - 新建转码任务接口中指定WaterMarks参数。 水印模板仅包含水印的位置、大小属性，不包含水印素材。水印素材需要在提交媒资转码任务时添加。 水印模板可以通过控制台，或调用 CreateWatermarkTemplate - 新建水印模板。

请求示例 新建水印模板，水印模板目前默认支持创建100000个。 POST 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" : "10", "dy" : "10", "referpos" : "BottomLeft", "timeline_start" : "6", "timeline_duration" : "8" }

请求参数 表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（文字水印）。

功能介绍 自定义水印模板，水印模板目前默认支持创建100000个。 在视频内容中嵌入可见的水印，水印有多种应用场景和内容类型，例如:"赞助商或合作伙伴Logo"、"质量或认证标志"等。 水印模板是预设的一系列参数集合，用于定义水印的位置、大小等关键属性。通过使用水印模板，开发者可以简化水印应用的开发流程，实现快速、一致的水印添加效果。 水印模板只适用于图片水印，不适用于文字水印。文字水印请在CreateTranscodingTask - 新建转码任务接口中指定WaterMarks参数。 水印模板仅包含水印的位置、大小属性，不包含水印素材。水印素材需要在提交媒资转码任务时添加。 水印模板可以通过控制台，或调用 CreateWatermarkTemplate - 新建水印模板。

请求示例 新建水印模板，水印模板目前默认支持创建100000个。 POST 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" : "10", "dy" : "10", "referpos" : "BottomLeft", "timeline_start" : "6", "timeline_duration" : "8" }

功能介绍 自定义水印模板，水印模板目前默认支持创建100000个。 在视频内容中嵌入可见的水印，水印有多种应用场景和内容类型，例如:"赞助商或合作伙伴Logo"、"质量或认证标志"等。 水印模板是预设的一系列参数集合，用于定义水印的位置、大小等关键属性。通过使用水印模板，开发者可以简化水印应用的开发流程，实现快速、一致的水印添加效果。 水印模板只适用于图片水印，不适用于文字水印。文字水印请在CreateTranscodingTask - 新建转码任务接口中指定WaterMarks参数。 水印模板仅包含水印的位置、大小属性，不包含水印素材。水印素材需要在提交媒资转码任务时添加。 水印模板可以通过控制台，或调用 CreateWatermarkTemplate - 新建水印模板。

请求参数 表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（文字水印）。

响应示例 状态码：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 客户端语言

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 task_array Array of ThumbTask objects 截图任务组 is_truncated Integer 查询结果是否被截取。 1代表被截取，即还有结果未被返回，可以通过设置page和size参数继续查询。 0代表未被截取，即所有结果已被返回。 total Integer 查询结果的数量。 表5 ThumbTask 参数 参数类型 描述 task_id String 任务ID。 截图服务接受任务后产生的任务ID。一次最多10个。 status String 任务状态 create_time String 起始时间。 格式为yyyymmddhhmmss。必须是与时区无关的UTC时间，指定task_id时该参数无效。 end_time String 结束时间。 格式为yyyymmddhhmmss。必须是与时区无关的UTC时间，指定task_id时该参数无效。 input ObsObjInfo object 输入存储位置。 output ObsObjInfo object 输出存储位置。 output_file_name String 输出文件名。 user_data String 用户数据。 description String 任务描述。 thumbnail_info Array of PicInfo objects 截图文件信息。 表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 PicInfo 参数 参数类型 描述 pic_name String 截图文件名。 状态码：400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg 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。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 task_array Array of ThumbTask objects 截图任务组 is_truncated Integer 查询结果是否被截取。 1代表被截取，即还有结果未被返回，可以通过设置page和size参数继续查询。 0代表未被截取，即所有结果已被返回。 total Integer 查询结果的数量。 表5 ThumbTask 参数 参数类型 描述 task_id String 任务ID。 截图服务接受任务后产生的任务ID。一次最多10个。 status String 任务状态 create_time String 起始时间。 格式为yyyymmddhhmmss。必须是与时区无关的UTC时间，指定task_id时该参数无效。 end_time String 结束时间。 格式为yyyymmddhhmmss。必须是与时区无关的UTC时间，指定task_id时该参数无效。 input ObsObjInfo object 输入存储位置。 output ObsObjInfo object 输出存储位置。 output_file_name String 输出文件名。 user_data String 用户数据。 description String 任务描述。 thumbnail_info Array of PicInfo objects 截图文件信息。 表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 PicInfo 参数 参数类型 描述 pic_name String 截图文件名。 状态码：400 表8 响应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 客户端语言

响应示例 状态码：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." }

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

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 task_array Array of ThumbTask objects 截图任务组 is_truncated Integer 查询结果是否被截取。 1代表被截取，即还有结果未被返回，可以通过设置page和size参数继续查询。 0代表未被截取，即所有结果已被返回。 total Integer 查询结果的数量。 表5 ThumbTask 参数 参数类型 描述 task_id String 任务ID。 截图服务接受任务后产生的任务ID。一次最多10个。 status String 任务状态 create_time String 起始时间。 格式为yyyymmddhhmmss。必须是与时区无关的UTC时间，指定task_id时该参数无效。 end_time String 结束时间。 格式为yyyymmddhhmmss。必须是与时区无关的UTC时间，指定task_id时该参数无效。 input ObsObjInfo object 输入存储位置。 output ObsObjInfo object 输出存储位置。 output_file_name String 输出文件名。 user_data String 用户数据。 description String 任务描述。 thumbnail_info Array of PicInfo objects 截图文件信息。 表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 PicInfo 参数 参数类型 描述 pic_name String 截图文件名。 状态码：400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码：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: 等待启动 PROCESSING：截图中 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。

响应示例 状态码：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." }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 task_array Array of ThumbTask objects 截图任务组 is_truncated Integer 查询结果是否被截取。 1代表被截取，即还有结果未被返回，可以通过设置page和size参数继续查询。 0代表未被截取，即所有结果已被返回。 total Integer 查询结果的数量。 表5 ThumbTask 参数 参数类型 描述 task_id String 任务ID。 截图服务接受任务后产生的任务ID。一次最多10个。 status String 任务状态 create_time String 起始时间。 格式为yyyymmddhhmmss。必须是与时区无关的UTC时间，指定task_id时该参数无效。 end_time String 结束时间。 格式为yyyymmddhhmmss。必须是与时区无关的UTC时间，指定task_id时该参数无效。 input ObsObjInfo object 输入存储位置。 output ObsObjInfo object 输出存储位置。 output_file_name String 输出文件名。 user_data String 用户数据。 description String 任务描述。 thumbnail_info Array of PicInfo objects 截图文件信息。 表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 PicInfo 参数 参数类型 描述 pic_name String 截图文件名。 状态码：400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。