华为云用户手册

请求示例 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" }

请求参数 表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": "********", //IAM用户密码 "domain": { "name": "domainname" //IAM用户所属帐号名 } } } }, "scope": { "project": { "name": "xxxxxxxx" //项目名称 } } }} 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 123 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projectsContent-Type: application/jsonX-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用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不同，使用时请注意。

URI GET /v1/{project_id}/template/watermark 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参考获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 template_id 否 Array 水印模板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：左下角。 timeline_start String 水印开始时间，与“timeline_duration”配合使用。 取值范围：数字。 单位：秒。 timeline_duration String 水印持续时间，与“timeline_start”配合使用。 取值范围：[数字，ToEND]。“ToEND”表示持续到视频结束。 默认值：ToEND。 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 错误描述。

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

请求参数 表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和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 消息体的类型（格式）。推荐用户使用默认值application/json，有其他取值时会在具体接口中专门说明。 是 application/json Content-Length 请求body长度，单位为Byte。 否 3495 X-Project-Id project id，项目编号。请参考获取项目ID章节获取项目编号。 否 如果是专属云场景采用AK/SK认证方式的接口请求，或者多project场景采用AK/SK认证的接口请求，则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头（Headers）中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注：以下仅为Token示例片段。 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证，AK/SK认证使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 12 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokensContent-Type: application/json

请求消息体（可选） 该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的帐号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的名称，如“cn-north-1”，您可以从地区和终端节点获取。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个帐号下所有资源或帐号的某个project下的资源，详细定义请参见获取用户Token。 1 2 3 4 5 6 7 8 91011121314151617181920212223242526 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokensContent-Type: application/json{ "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } }} 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中的“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求URI 请求URI由如下部分组成： {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点获取。 例如IAM服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径，即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“?”，形式为“参数名=参数取值”，例如“?limit=10”，表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京四”区域的Token，则需使用“华北-北京四”区域的Endpoint（iam.cn-north-4.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 1 https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为方便查看，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务您正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候，PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： 1 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

请求参数 表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时, 只需指定到转码结果期望存放的路径。 file_name 否 String 文件名 当指定了此参数时，输出的对象名为object/file_name 。 当不指定此参数时，输出的对象名为object/xxx，其中xxx由MPC指定。 在作为输出文件名时： 在转封装场景有效，指定输出文件名称 转码场景下需要指定输出文件名时，请使用output_filenames参数 在解析场景有效，解析场景如果指定文件名，则将解析参数写入指定文件名，通过查询接口响应json数据获取文件元数据信息 在截图场景无效 在转动图场景无效 表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": "zitest", "location": "region1", "object": "input/flv_1.flv" }, "output": { "bucket": "zitest", "location": "region1", "object": "output/", "file_name" : "test.m3u8" }, "output_param": { "format":"HLS", "segment_duration": 7 }}

请求示例 POST https://{endpoint}/v1/{project_id}/animated-graphics { "input": { "bucket": "obs-63bc", "location": "region1", "object": "thumb.mp4" }, "output": { "bucket": "obs-63bc", "location": "region1", "object": "/b", "file_name": "test_mpc.gif" }, "output_param": { "format": "gif", "width": 480, "height": 360, "frame_rate": 15, "start": 100, "end": 250 } }

请求参数 表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 否 AnimatedGraphicsOutputParam object 动图输出参数。 表4 ObsObjInfo 参数 是否必选 参数类型 描述 bucket 是 String OBS的bucket名称。 location 是 String OBS桶所在的区域，且必须与使用的MPC区域保持一致。 object 是 String OBS对象路径，遵守OSS Object定义。 当用于指示input时,需要指定到具体对象。 当用于指示output时, 只需指定到转码结果期望存放的路径。 file_name 否 String 文件名 当指定了此参数时，输出的对象名为object/file_name 。 当不指定此参数时，输出的对象名为object/xxx，其中xxx由MPC指定。 在作为输出文件名时： 在转封装场景有效，指定输出文件名称 转码场景下需要指定输出文件名时，请使用output_filenames参数 在解析场景有效，解析场景如果指定文件名，则将解析参数写入指定文件名，通过查询接口响应json数据获取文件元数据信息 在截图场景无效 在转动图场景无效 表5 AnimatedGraphicsOutputParam 参数 是否必选 参数类型 描述 format 否 String 动图格式，目前仅支持取值 gif width 是 Integer 输出动图的宽。 取值范围：0，-1或[32,3840]之间2的倍数。 说明： 若设置为-1， 则宽根据高来自适应，此时“height”不能取-1或0。 若设置为0，则取原始视频的宽，此时“height”只能取0。 height 是 Integer 输出动图的高。 取值范围：0，-1或[32,2160]之间2的倍数。 说明： 若设置为-1， 则高根据宽来自适应，此时“width”不能取-1或0。 若设置为0，则取原始视频的高，此时“width”只能取0。 start 是 Integer 起始时间。 单位：毫秒 end 是 Integer 结束时间。 单位：毫秒。 end、start差值最多60秒。 frame_rate 否 Integer 动图帧率。 取值范围：[1,75]

响应示例 状态码： 200 查询转封装任务成功。 { "total" : 1, "tasks" : [ { "task_id" : 10743, "status" : "SUCCEED", "create_time" : 20201117021558, "start_time" : 20201117021558, "end_time" : 20201117021559, "description" : "The task has completed.", "input" : { "bucket" : "obs-apitest-01", "location" : "region1", "object" : "flv/flv.flv" }, "output" : { "bucket" : "obs-apitest-01", "location" : "region1", "object" : "out_gamma/remux/ucAMb.mp4", "file_name" : "bf00ba898a3dfb3560a292fd87f790db.mp4" }, "user_data" : 1795687, "output_param" : { "format" : "MP4", "segment_duration" : 5, "remove_meta" : false }, "complete_ratio" : 100, "output_metadata" : { "size" : 3189068, "duration_ms" : 25.48, "duration" : 25, "format" : "mp4", "bitrate" : 977, "video" : [ { "width" : 1920, "height" : 1080, "bitrate" : 977, "bitrate_bps" : 1001277, "frame_rate" : 25, "codec" : "H.264" } ], "audio" : [ { "sample" : 48000, "channels" : 2, "bitrate" : 0, "bitrate_bps" : 0 } ] } } ]} 状态码： 400 查询转封装任务失败。 { "error_code" : "MPC.10202", "error_msg" : "Invalid request parameter."}

URI GET /v1/{project_id}/remux 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参考获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 task_id 否 Array 任务ID。一次最多10个 status 否 String 任务执行状态。 取值如下： INIT：初始状态 WAITING：等待启动 PRO CES SING：处理中 SUCCEED：处理成功 FAILED：处理失败 CANCELED：已取消 start_time 否 String 起始时间。格式为yyyymmddhhmmss。必须是与时区无关的UTC时间，指定task_id时该参数无效 end_time 否 String 结束时间。格式为yyyymmddhhmmss。必须是与时区无关的UTC时间，指定task_id时该参数无效 input_bucket 否 String 源文件存储桶。 input_object 否 String 源对象名称. page 否 Integer 分页编号。查询指定“task_id”时，该参数无效。 默认值：0。 size 否 Integer 每页记录数。查询指定“task_id”时，该参数无效。 取值范围：[1,100]。 默认值：10。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 任务总数 tasks Array of RemuxTask objects 任务列表 表5 RemuxTask 参数 参数类型 描述 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 输出文件信息 output_param RemuxOutputParam object 输出参数 complete_ratio Integer 任务完成进度百分比值。 output_metadata MetaData object 转封装出文件的元数据信息。 表6 ObsObjInfo 参数 参数类型 描述 bucket String OBS的bucket名称。 location String OBS桶所在的区域，且必须与使用的MPC区域保持一致。 object String OBS对象路径，遵守OSS Object定义。 当用于指示input时,需要指定到具体对象。 当用于指示output时, 只需指定到转码结果期望存放的路径。 file_name String 文件名 当指定了此参数时，输出的对象名为object/file_name 。 当不指定此参数时，输出的对象名为object/xxx，其中xxx由MPC指定。 在作为输出文件名时： 在转封装场景有效，指定输出文件名称 转码场景下需要指定输出文件名时，请使用output_filenames参数 在解析场景有效，解析场景如果指定文件名，则将解析参数写入指定文件名，通过查询接口响应json数据获取文件元数据信息 在截图场景无效 在转动图场景无效 表7 RemuxOutputParam 参数 参数类型 描述 format String 输出格式。取值范围： HLS MP4 segment_duration Integer 分片时长，仅当“format”为“HLS”时有效。 参考取值范围：[2，10]。 默认值： 5。 单位：秒。 说明： 若设置的分片时长不在取值范围内，则自动调整为5。 remove_meta Boolean 输出媒体是否去除片源的中metadata自定义信息。默认值：false 表8 MetaData 参数 参数类型 描述 size Long 文件大小。 单位：byte。 duration_ms Double 视频时长，带小数位显示。 单位：秒。 duration Long 视频时长。 单位：秒。 format String 文件封装格式。 bitrate Long 总码率。 单位：bit/秒 video Array of VideoInfo objects 视频流元数据。 audio Array of AudioInfo objects 音频流元数据。 表9 VideoInfo 参数 参数类型 描述 width Integer 视频宽度 height Integer 视频高度 bitrate Integer 视频码率。 单位: kbit/s bitrate_bps Long 视频码率。 单位: bit/s frame_rate Integer 帧率。 取值范围：0或[5,60]，0表示自适应。 单位：帧每秒。 说明： 若设置的帧率不在取值范围内，则自动调整为0，若设置的帧率高于片源帧率，则自动调整为片源帧率。 codec String 视频编码格式 表10 AudioInfo 参数 参数类型 描述 codec String 音频编码格式 sample Integer 音频采样率 channels Integer 音频信道 bitrate Integer 音频码率。 单位: kbit/s bitrate_bps Long 音频码率。 单位: bit/s 状态码： 400 表11 响应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方式认证时必选，请求的发生时间。

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

调用API获取项目ID 您还能通过调用查询指定条件下的项目信息API获取项目ID。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”，其中{Endpoint}为IAM的终端节点，可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下，其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "region01", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 任务总数 tasks Array of AnimatedGraphicsTask objects 任务列表 表5 AnimatedGraphicsTask 参数 参数类型 描述 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 输出文件信息 output_param AnimatedGraphicsOutputParam object 动图输出参数。 表6 ObsObjInfo 参数 参数类型 描述 bucket String OBS的bucket名称。 location String OBS桶所在的区域，且必须与使用的MPC区域保持一致。 object String OBS对象路径，遵守OSS Object定义。 当用于指示input时,需要指定到具体对象。 当用于指示output时, 只需指定到转码结果期望存放的路径。 file_name String 文件名 当指定了此参数时，输出的对象名为object/file_name 。 当不指定此参数时，输出的对象名为object/xxx，其中xxx由MPC指定。 在作为输出文件名时： 在转封装场景有效，指定输出文件名称 转码场景下需要指定输出文件名时，请使用output_filenames参数 在解析场景有效，解析场景如果指定文件名，则将解析参数写入指定文件名，通过查询接口响应json数据获取文件元数据信息 在截图场景无效 在转动图场景无效 表7 AnimatedGraphicsOutputParam 参数 参数类型 描述 format String 动图格式，目前仅支持取值 gif width Integer 输出动图的宽。 取值范围：0，-1或[32,3840]之间2的倍数。 说明： 若设置为-1， 则宽根据高来自适应，此时“height”不能取-1或0。 若设置为0，则取原始视频的宽，此时“height”只能取0。 height Integer 输出动图的高。 取值范围：0，-1或[32,2160]之间2的倍数。 说明： 若设置为-1， 则高根据宽来自适应，此时“width”不能取-1或0。 若设置为0，则取原始视频的高，此时“width”只能取0。 start Integer 起始时间。 单位：毫秒 end Integer 结束时间。 单位：毫秒。 end、start差值最多60秒。 frame_rate Integer 动图帧率。 取值范围：[1,75] 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 200 查询动图任务成功。 { "total" : 1, "tasks" : [ { "task_id" : 30647, "status" : "SUCCEED", "create_time" : 20201119103652, "start_time" : 20201119103653, "end_time" : 20201119103708, "description" : "The task has completed.", "input" : { "bucket" : "obs-apitest-01", "location" : "region1", "object" : "mp4/4k.mp4" }, "output" : { "bucket" : "obs-apitest-01", "location" : "region1", "object" : "out_gamma/gif_file/", "file_name" : "file_001.gif" }, "output_param" : { "format" : "gif", "width" : 100, "height" : 50, "start" : 0, "end" : 10000, "frame_rate" : 15 } } ]} 状态码： 400 查询动图任务失败。 { "error_code" : "MPC.10202", "error_msg" : "Invalid request parameter."}

URI GET /v1/{project_id}/animated-graphics 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参考获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 task_id 否 Array 任务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。

请求参数 表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 客户端语言

请求参数 表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 表5 响应Body参数 参数 参数类型 描述 task_id String 任务ID status String 任务状态 create_time String 任务创建时间 output ObsObjInfo object 输出文件信息 output_file_name String 解析文件名称 description String 任务描述，如当任务异常时，此字段为异常的具体信息 metadata MetaData object 视频文件元数据 表6 ObsObjInfo 参数 参数类型 描述 bucket String OBS的bucket名称。 location String OBS桶所在的区域，且必须与使用的MPC区域保持一致。 object String OBS对象路径，遵守OSS Object定义。 当用于指示input时,需要指定到具体对象。 当用于指示output时, 只需指定到转码结果期望存放的路径。 file_name String 文件名 当指定了此参数时，输出的对象名为object/file_name 。 当不指定此参数时，输出的对象名为object/xxx，其中xxx由MPC指定。 在作为输出文件名时： 在转封装场景有效，指定输出文件名称 转码场景下需要指定输出文件名时，请使用output_filenames参数 在解析场景有效，解析场景如果指定文件名，则将解析参数写入指定文件名，通过查询接口响应json数据获取文件元数据信息 在截图场景无效 在转动图场景无效 表7 MetaData 参数 参数类型 描述 size Long 文件大小。 单位：byte。 duration_ms Double 视频时长，带小数位显示。 单位：秒。 duration Long 视频时长。 单位：秒。 format String 文件封装格式。 bitrate Long 总码率。 单位：bit/秒 video Array of VideoInfo objects 视频流元数据。 audio Array of AudioInfo objects 音频流元数据。 表8 VideoInfo 参数 参数类型 描述 width Integer 视频宽度 height Integer 视频高度 bitrate Integer 视频码率。 单位: kbit/s bitrate_bps Long 视频码率。 单位: bit/s frame_rate Integer 帧率。 取值范围：0或[5,60]，0表示自适应。 单位：帧每秒。 说明： 若设置的帧率不在取值范围内，则自动调整为0，若设置的帧率高于片源帧率，则自动调整为片源帧率。 codec String 视频编码格式 表9 AudioInfo 参数 参数类型 描述 codec String 音频编码格式 sample Integer 音频采样率 channels Integer 音频信道 bitrate Integer 音频码率。 单位: kbit/s bitrate_bps Long 音频码率。 单位: bit/s 状态码： 400 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。