华为云用户手册

URI GET /v1/{project_id}/transcodings 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 task_id 否 Array of longs 转码服务接受任务后产生的任务ID。一次最多10个 status 否 String 任务执行状态。 取值如下： WAITING：等待启动 TRANSCODING：转码中 SUCCEEDED：转码成功 FAILED：转码失败 CANCELED：已删除 NEED_TO_BE_AUDIT：片源待审核 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 查询转码任务成功。 { "is_truncated" : 0, "total" : 1, "task_array" : [ { "task_id" : 22123973, "status" : "SUCCEEDED", "create_time" : 20200310031605, "end_time" : 20200310031623, "trans_template_id" : [ 4 ], "input" : { "bucket" : "example-bucket", "location" : "region01", "object" : "example-input.mp4" }, "output" : { "bucket" : "example-bucket", "location" : "region01", "object" : "example-output.mp4" }, "output_file_name" : [ "example_480X270.m3u8" ], "transcode_detail" : { "multitask_info" : [ { "template_id" : 4, "output_file" : { "duration" : 59, "duration_ms" : 0, "format" : "HLS", "size" : 2180, "video_info" : { "width" : 480, "height" : 270, "bitrate" : 231, "bitrate_bps" : 0, "frame_rate" : 25000, "codec" : "H264" }, "audio_info" : [ { "codec" : "HEAAC", "sample" : 44100, "channels" : 2, "bitrate" : 64, "bitrate_bps" : 0 } ] } } ], "input_file" : { "duration" : 59, "duration_ms" : 0, "format" : "MOV", "size" : 2494653, "video_info" : { "width" : 480, "height" : 270, "bitrate" : 199, "bitrate_bps" : 0, "frame_rate" : 25000, "codec" : "HEVC" }, "audio_info" : [ { "codec" : "AAC", "sample" : 48000, "channels" : 2, "bitrate" : 128, "bitrate_bps" : 0 } ] } } } ] } 状态码：400 查询转码任务失败。 { "error_code" : "MPC.10202", "error_msg" : "Invalid request parameter" }

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

请求示例 新建水印模板，水印模板目前默认支持创建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（文字水印）。

请求参数 表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方式认证时必选，请求的发生时间。

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 查询转码模板成功。 { "template_array" : [ { "template_id" : 80985, "template" : { "template_name" : "test_template", "video" : { "output_policy" : "transcode", "codec" : 1, "bitrate" : 0, "profile" : 3, "level" : 15, "preset" : 3, "max_iframes_interval" : 5, "bframes_count" : 4, "frame_rate" : 0, "width" : 0, "height" : 0, "black_cut" : 0 }, "audio" : { "output_policy" : "transcode", "codec" : 1, "bitrate" : 0, "sample_rate" : 1, "channels" : 2 }, "common" : { "PVC" : false, "hls_interval" : 5, "dash_interval" : 5, "pack_type" : 1 } } } ], "total" : 1 } 状态码：403 查询转码模板失败。 { "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方式认证时必选，请求的发生时间。

URI GET /v1/{project_id}/template/transcodings 表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时该参数无效

响应示例 状态码：200 查询转码概览信息成功。 { "stat_type" : "transcode_task_number", "total" : 5.0, "summary" : [ { "value" : "2.0", "date" : "2022/11/25" }, { "value" : "3.0", "date" : "2022/11/25" } ] } 状态码：400 查询转码概览信息失败。 { "error_code" : "MPC.10202", "error_msg" : "Invalid request parameter, start_time cannot be greater than end_time." }

请求参数 表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参数 参数 参数类型 描述 summary Array of StatSummary objects 统计概览信息 total Float 该指标的总值，精确到小数点后两位。 stat_type String 统计类型。取值如下： video_duration, 转码片源时长统计，单位：分钟。 remux_file_duration，转封装片源时长统计，单位：分钟。 transcode_task_number，转码次数统计，单位：次。 transcode_duration，转码耗时时长统计，单位：分钟。 表5 StatSummary 参数 参数类型 描述 value Float 精确到小数点后两位。 date String 日期，精确到天，格式样例：2018/03/01。 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

URI GET /v1/{project_id}/transcodings/summaries 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 start_time 是 String 开始时间。格式为yyyymmdd。必须是与时区无关的UTC时间。 end_time 是 String 结束时间。格式为yyyymmdd。必须是与时区无关的UTC时间。 stat_type 是 String 统计类型。取值如下： video_duration, 转码片源时长统计，单位：分钟。 remux_file_duration，转封装片源时长统计，单位：分钟。 transcode_task_number，转码次数统计，单位：次。 transcode_duration，转码耗时时长统计，单位：分钟。

响应示例 状态码：200 查询消息订阅功能板块， SMN 主题的所有订阅事件成功。 { "total" : 7, "event_name" : [ "TranscodeComplete", "TranscodeStart", "ThumbnailComplete", "RemuxComplete", "AnimatedGraphicsComplete", "ParseComplete", "EditingComplete" ] } 状态码：403 查询消息订阅功能板块，SMN主题的所有订阅事件失败。 { "error_code" : "MPC.10208", "error_msg" : "Failed to verify the tenant ID." }

请求参数 表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方式认证时必选，请求的发生时间。

请求示例 新建转码模板，采用自定义的模板转码。 POST https://{endpoint}/v1/{project_id}/template/transcodings { "template_name" : "MP4_H.264_1920x1080_6000_HEAAC", "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 } }

请求参数 表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方式认证时必选，请求的发生时间。

授权与配置 接口 说明 PUT /v1/{project_id}/notification 配置转码服务端事件通知 GET /v1/{project_id}/notification 查询转码服务端事件通知 GET /v1/{project_id}/notification/event 查询转码服务端所有事件 GET /v1/{project_id}/buckets 查询桶列表 PUT /v1/{project_id}/authority 桶授权或取消授权 GET /v1.0-ext/{project_id}/objects 查询桶里的object POST /v1/{project_id}/agencies 请求委托任务 GET /v1/{project_id}/agencies 查询创建委托任务状态

转动图 接口 说明 POST /v1/{project_id}/animated-graphics 新建动图任务 GET /v1/{project_id}/animated-graphics{?task_id,start_time,end_time,status,page,size} 查询动图任务 DELETE /v1/{project_id}/animated-graphics{?task_id} 取消动图任务

独立加密 接口 说明 POST /v1/{project_id}/encryptions 新建独立加密任务 DELETE /v1/{project_id}/encryptions/?task_id={task_id} 取消独立加密任务 GET /v1/{project_id}/encryptions{?task_id,start_time,end_time,status,page,size} 查询独立加密任务

转封装 接口 说明 POST /v1/{project_id}/remux 新建转封装任务 PUT /v1/{project_id}/remux 重试转封装任务 GET /v1/{project_id}/remux{?task_id,start_time,end_time,status,page,size} 查询转封装任务 DELETE /v1/{project_id}/remux{?task_id} 取消转封装任务 DELETE /v1/{project_id}/remux/task 删除转封装任务记录

媒资转码 接口 说明 POST /v1/{project_id}/transcodings 新建转码任务 DELETE /v1/{project_id}/transcodings{?task_id} 取消转码任务 GET /v1/{project_id}/transcodings{?task_id,start_time,end_time,status,page,size} 查询转码任务 DELETE /v1/{project_id}/transcodings/task 删除转码任务记录 GET /v1/{project_id}/transcodings/summaries 查询点播概览信息

视频解析 接口 说明 POST /v1/{project_id}/extract-metadata 创建视频解析任务 GET /v1/{project_id}/template/extract-metadata{?task_id,start_time,end_time,status,page,size} 查询视频解析任务 DELETE /v1/{project_id}/extract-metadata{?task_id} 取消视频解析任务

配置水印模板 通过配置水印模板接口，在转码过程中下发水印模板，为视频添加水印。 接口 说明 POST /v1/{project_id}/template/watermark 新建水印模板 PUT /v1/{project_id}/template/watermark 更新水印模板 DELETE /v1/{project_id}/template/watermark{?template_id} 删除水印模板 GET /v1/{project_id}/template/watermark{?template_id,page,size} 查询水印模板

自定义转码模板 转码模板用于定义转码后的视频信息，视频转码时，需提前创建转码模板。 接口 说明 POST /v1/{project_id}/template/transcodings 新建转码模板 DELETE /v1/{project_id}/template/transcodings{?temp_id} 删除转码模板 PUT /v1/{project_id}/template/transcodings 更新转码模板 GET /v1/{project_id}/template/transcodings{?temp_id} 查询转码模板

自定义转码模板组 转码模板组用于定义转码后的媒资信息，最多支持一进六转码模板组。 接口 说明 POST /v1/{project_id}/template_group/transcodings 新建转码模板组 GET /v1/{project_id}/template_group/transcodings{?temp_id} 查询转码模板组列表 PUT /v1/{project_id}/template_group/transcodings{?temp_id} 更新转码模板组 DELETE /v1/{project_id}/template_group/transcodings 删除转码模板组

响应示例 状态码：200 查询独立加密任务成功。 { "task_array" : [ { "task_id" : 31207, "status" : "SUCCEEDED", "create_time" : 20201119103952, "end_time" : 20201119104051, "input" : { "bucket" : "example-bucket", "location" : "region01", "object" : "encrypt/m3u8/index.m3u8" }, "output" : { "bucket" : "example-bucket", "location" : "region01", "object" : "out_gamma/encrypt/001" }, "output_file_name" : [ "index.m3u8" ] } ], "is_truncated" : 0, "total" : 1 } 状态码：400 查询独立加密任务失败。 { "error_code" : "MPC.10202", "error_msg" : "Invalid request parameter." }