华为云用户手册

  • 请求示例 更新转码模板组。 PUT https://{endpoint}/v1/{project_id}/template_group/transcodings { "group_id" : "bd55741ccdf04e678f800c010aa12b68", "name" : "test_group", "videos" : [ { "width" : 480, "height" : 270, "bitrate" : 200 }, { "width" : "1280", "height" : "720", "bitrate" : "700" } ], "audio" : { "codec" : 1, "sample_rate" : 1, "channels" : 2, "bitrate" : 0 }, "video_common" : { "codec" : 1, "black_cut" : 0, "profile" : 3, "level" : 15, "preset" : 3, "max_iframes_interval" : 5, "bframes_count" : 4, "frame_rate" : 0 }, "common" : { "PVC" : false, "pack_type" : 1, "hls_interval" : 5, "dash_interval" : 5 } }
  • 请求参数 表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的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 is_open 否 Boolean 是否已开通服务 false:未开通 true:已开通 agreement_version 否 Integer 服务协议版本
  • 修订记录 表1 修订记录 发布日期 修订记录 2023-05-04 第三十一次正式发布 本次变更如下: 修改新建转码模板组接口示例代码。 2023-02-02 第三十次正式发布 本次变更如下: 删除新建转码任务接口中的“asset_id”和“dynamic_range”参数。 新建转动图任务接口中增加源文件格式说明,在转动图、同步解析和同步截图场景下,暂不支持m3u8格式的视频。 2023-01-03 第二十九次正式发布 本次变更如下: 修改新建转码任务接口中的“language”参数。 修改新建转码任务、查询转码任务、新建转码模板、更新转码模板、查询转码模板、新建转码模板组、更新转码模板组和查询转码模板组接口中的“level”和“channels”参数。 2022-12-09 第二十八次正式发布 本次变更如下: 删除新建转码模板、更新转码模板和查询转码模板接口中的“black_cut”参数。 删除新建转码模板组、更新转码模板组和查询转码模板组接口中的“ref_frames_count”和“aspect_ratio”参数。 删除新建转码任务接口中的“audio_track”、“multi_audio”和“video_process”参数。 2022-11-30 第二十七次正式发布 本次变更如下: 媒资转码接口组新增删除转码任务记录、查询点播概览信息接口。 转封装接口组新增删除转封装任务记录接口。 新增授权与配置接口组。 2022-08-26 第二十六次正式发布 本次变更如下: 修改新建截图任务、新建转码模板组和更新水印模板接口的格式错误。 修改新建转码任务、新建转码模板、更新转码模板、查询转码模板、查询转码模板组和新建独立加密任务接口的响应参数错误。 2022-06-21 第二十五次正式发布 本次变更如下: 修改新建转码任务接口中的“preset”编码质量等级。 2022-06-02 第二十四次正式发布 本次变更如下: 修改新建独立加密任务接口“Key”字段的描述和请求示例代码。 2022-03-17 第二十三次正式发布 本次变更如下: 修改新建转码任务接口示例代码。 2021-12-27 第二十二次正式发布 本次变更如下: 修改查询转封装任务接口“size”字段的描述,增加单位byte。 水印模板接口组中新增字段“template_id”,表示水印模板ID。 2021-11-24 第二十一次正式发布 本次变更如下: 新建水印模板接口新增创建数量上限的说明,默认支持创建100000个水印模板。 2021-11-10 第二十次正式发布 本次变更如下: 新建转码任务接口中“font_name”字段删除msyh字体,当前仅支持fzyouh。 结构体“VideoProcess”中新增字段“hls_init_count”,表示需要单独设置时长的HLS起始分片数量。 结构体“VideoProcess”中新增字段“hls_init_interval”,表示HLS分片的时长。 删除查询视频解析任务接口中的“font_name”字段。 删除重复的错误码。 2021-10-29 第十九次正式发布 本次变更如下: “使用前必读”中新增接口调用区域的相关约束与限制。 2020-12-10 第十八次正式发布 本次变更如下: 新增错误码说明。 2020-10-14 第十七次正式发布 本次变更如下: 优化字段描述,ObsObjInfo结构中“file_name”仅用于转封装接口,表示指定输出转封装文件的名称。 媒资转码接口、转封装接口和转动图接口中新增字段“user_data”,表示用户自定义数据。 结构体“MetaData”和“SourceInfo”中新增字段“duration_ms”,表示片源时长。 结构体“VideoInfo”中新增字段“dynamic_range”,表示片源动态范围类型。 2020-06-20 第十六次正式发布 本次变更如下: 新增应用示例:提交转码任务。 新增应用示例:提交截图任务。 2020-01-21 第十五次正式发布 本次变更如下: 新增自定义转码模板组接口。 2019-07-02 第十四次正式发布 本次变更如下: 增加应用示例章节,提供新建转码模板接口的调用示例。 2019-06-28 第十三次正式发布 本次变更如下: 新增动图管理接口。 新增视频解析接口。 2019-6-26 第十二次正式发布 本次变更如下: 新增转封装接口。 2019-04-29 第十一次正式发布 本次变更如下: 查询转码任务接口添加片源和输出文件信息。 2019-03-21 第十次正式发布 本次变更如下: 修改新建转码模板接口中的“pack_type”的描述。 2019-03-21 第九次正式发布 本次变更如下: 调整概述部分的结构,优化相关描述。 2018-10-25 第八次正式发布 本次变更如下: 修改转码模板id参数类型为Long类型。 2018-10-16 第七次正式发布 本次变更如下: 查询转码任务接口返回字段增加“TaskInfo”的异常描述“description”参数。 2018-09-30 第六次正式发布 本次变更如下: 新建转码接口和新建截图任务接口去除模板ID,改为截图信息结构。 2018-09-21 第五次正式发布 本次变更如下: 查询转码任务接口将原先的“detail_error”字段换成“transcode_detail”、“transcode_detail”,包含“Multitask_info”。 2018-05-16 第四次正式发布 本次变更如下: 在创建转码任务接口增加了水印相关参数。 增加水印模板接口。 2019-04-26 第三次正式发布 本次变更如下: 修改转码模板参数及范围。 2018-04-24 第二次正式发布 本次变更如下: 创建拼接任务接口中“format”字段增加“HLS_DASH”类型。 2018-03-31 第一次正式发布。
  • 请求示例 POST https://{endpoint}/v1/{project_id}/encryptions { "output" : { "bucket" : "example-bucket", "location" : "region01", "object" : "example-path/output" }, "input" : { "bucket" : "example-bucket", "location" : "region01", "object" : "example-hls-path/index.m3u8" }, "encryption" : { "hls_encrypt" : { "iv" : "******", "key" : "******", "url" : "http://{your-keyserver}", "algorithm" : "AES-128-CBC" } } }
  • 请求参数 表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 输出存储位置 encryption 否 Encryption object 加密信息 user_data 否 String 用户自定义数据。 表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 Encryption 参数 是否必选 参数类型 描述 hls_encrypt 否 HlsEncrypt object 视频加密控制参数。 表6 HlsEncrypt 参数 是否必选 参数类型 描述 key 是 String 使用base64编码的内容加密密钥 url 是 String 密钥获取服务的地址,用于播放hls分片时解密使用。 iv 否 String 初始向量,base64binary,随机数 algorithm 否 String 加密算法。 AES-128-CTR AES-128-CBC 默认值:AES-128-CTR
  • 调用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" } }
  • 请求示例 新建转码模板组,最多支持一进六出。 POST https://{endpoint}/v1/{project_id}/template_group/transcodings { "name" : "my_templateGroup", "videos" : [ { "width" : "480", "height" : "270", "bitrate" : "200" } ], "audio" : { "codec" : 1, "sample_rate" : 1, "channels" : 2, "bitrate" : 0 }, "video_common" : { "codec" : 1, "black_cut" : 0, "profile" : 3, "level" : 15, "preset" : 3, "max_iframes_interval" : 5, "bframes_count" : 4, "frame_rate" : 0 }, "common" : { "PVC" : false, "pack_type" : 1, "hls_interval" : 5, "dash_interval" : 5 } }
  • 响应示例 状态码:201 新建转码模板组成功。 { "template_group" : { "group_id" : "f7fc420b17db414fb11652671581bb6d", "name" : "my_templateGroup", "template_ids" : [ 286548 ], "videos" : [ { "template_id" : 286548, "width" : 480, "height" : 270, "bitrate" : 200 } ], "audio" : { "output_policy" : "transcode", "codec" : 1, "bitrate" : 0, "sample_rate" : 1, "channels" : 2 }, "video_common" : { "output_policy" : "transcode", "codec" : 1, "profile" : 3, "level" : 15, "preset" : 1, "max_iframes_interval" : 5, "bframes_count" : 4, "frame_rate" : 0, "black_cut" : 0 }, "common" : { "PVC" : false, "hls_interval" : 5, "dash_interval" : 5, "pack_type" : 1 } } } 状态码:400 新建转码模板组失败。 { "error_code" : "MPC.10202", "error_msg" : "Invalid request parameter." }
  • 状态码 调用 媒体处理 API时,可能返回的状态码如表1所示。 表1 状态码 返回值 说明 200 OK 请求正常。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求,但未处理完成。 204 No Content 请求完全成功,同时HTTP响应不包含响应体。 400 Bad Request 非法请求。 建议直接修改该请求,不要重试该请求。 401 Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 403 Forbidden 请求被拒绝访问。 返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 404 Not Found 所请求的资源不存在。 建议直接修改该请求,不要重试该请求。 405 Method Not Allowed 请求中带有该资源不支持的方法。 建议直接修改该请求,不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证,与401类似,但请求者应当使用代理进行授权。 408 Request Timeout 服务器等候请求时发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码,表明客户端尝试创建的资源已经存在,或者由于冲突请求的更新操作不能被完成。 500 Internal Server Error 表明服务端能被请求访问到,但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能,无法完成请求。 502 Bad Gateway 充当网关或代理的服务器,从远端服务器接收到了一个无效的请求。 503 Service Unavailable 被请求的服务无效。 建议直接修改该请求,不要重试该请求。 504 Gateway Timeout 网关超时。 父主题: 附录
  • 请求消息头 附加请求头字段,如指定的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认证”。 对于管理员创建IAM用户接口,使用AK/SK方式认证时,添加消息头后的请求如下所示。 1 2 3 4 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Sdk-Date: 20240416T095341Z Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=****************
  • 请求消息体(可选) 该部分可选。请求消息体通常以结构化格式(如JSON或XML)发出,与请求消息头中Content-Type对应,传递除请求消息头之外的内容。若请求消息体中的参数支持中文,则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于管理员创建IAM用户接口,您可以从接口的请求部分看到所需的请求参数及参数说明,将消息体加入后的请求如下所示,其中加粗的字段需要根据实际值填写。 accountid为IAM用户所属的账号ID。 username为要创建的IAM用户名。 email为IAM用户的邮箱。 **********为IAM用户的登录密码。 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Sdk-Date: 20240416T095341Z Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=**************** { "user": { "domain_id": "accountid", "name": "username", "password": "**********", "email": "email", "description": "IAM User Description" } } 到这里为止这个请求需要的内容就具备齐全了,您可以使用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用户,由于IAM为全局服务,则使用任一区域的Endpoint,比如“华北-北京四”区域的Endpoint(iam.cn-north-4.myhuaweicloud.com),并在管理员创建IAM用户的URI部分找到resource-path(/v3.0/OS-USER/users),拼接起来如下所示。 1 https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users 图1 URI示意图 为方便查看,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
  • 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务您正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源,如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候,PATCH可能会去创建一个新的资源。 在管理员创建IAM用户的URI部分,您可以看到其请求方法为“POST”,则其请求为: 1 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users
  • 请求示例 新建转码任务,可以将视频进行转码。 POST https://{endpoint}/v1/{project_id}/transcodings { "input" : { "bucket" : "example-bucket", "location" : "region01", "object" : "example-path/input.mp4" }, "output" : { "bucket" : "example-bucket", "location" : "region01", "object" : "example-path/output" }, "trans_template_id" : [ 1002, 1003, 1004, 1005 ], "priority" : "9", "subtitle" : { "subtitle_type" : 1, "input" : { "bucket" : "example-bucket", "location" : "region01", "object" : "example-subtitle.srt" } }, "encryption" : { "hls_encrypt" : { "iv" : "******", "key" : "******", "url" : "http://{your-keyserver}", "algorithm" : "AES-128-CBC" } }, "thumbnail" : { "out" : { "bucket" : "example-bucket", "location" : "region01", "object" : "example/path" }, "tar" : 1, "params" : { "time" : 2, "format" : 1, "max_length" : 480 } } }
  • 请求参数 表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 表3 响应Body参数 参数 参数类型 描述 buckets Array of ObsBucket objects 桶列表 表4 ObsBucket 参数 参数类型 描述 bucket String 桶名称 creation_date String 桶的创建时间 is_authorized Integer 授权结果 取值范围为[0,1] 0:表示未授权给转码服务 1:表示已授权转码服务 状态码:403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。
  • 请求参数 表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方式认证时必选,请求的发生时间。
  • 响应示例 状态码:200 查询桶列表成功。 { "buckets" : [ { "bucket" : "example-bucket", "creation_date" : 20221026152511, "is_authorized" : 1 }, { "bucket" : "example-bucket", "creation_date" : 20221026104736, "is_authorized" : 0 } ] } 状态码:403 查询桶列表失败。 { "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方式认证时必选,请求的发生时间。 表3 请求Body参数 参数 是否必选 参数类型 描述 task_id 否 String 任务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方式认证时必选,请求的发生时间。 表3 请求Body参数 参数 是否必选 参数类型 描述 task_id 否 String 任务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方式认证时必选,请求的发生时间。 表3 请求Body参数 参数 是否必选 参数类型 描述 task_id 否 String 任务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方式认证时必选,请求的发生时间。 表3 请求Body参数 参数 是否必选 参数类型 描述 task_id 否 String 任务ID。
  • 响应示例 状态码:200 查询转码模板组成功。 { "total" : 1, "template_group_list" : [ { "group_id" : "397565a34913415c91955254add0461a", "name" : "test_templageGroup", "template_ids" : [ 276195 ], "videos" : [ { "template_id" : 276195, "width" : 854, "height" : 480, "bitrate" : 500 } ], "audio" : { "output_policy" : "transcode", "codec" : 1, "bitrate" : 0, "sample_rate" : 1, "channels" : 2 }, "video_common" : { "output_policy" : "transcode", "codec" : 1, "profile" : 3, "level" : 15, "preset" : 3, "max_iframes_interval" : 5, "bframes_count" : 4, "frame_rate" : 0, "black_cut" : 0 }, "common" : { "PVC" : false, "hls_interval" : 5, "dash_interval" : 5, "pack_type" : 4 } } ] } 状态码:403 查询转码模板组失败。 { "error_code" : "MPC.10212", "error_msg" : "Operation failed." }
  • URI GET /v1/{project_id}/template_group/transcodings 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 group_id 否 Array of strings 转码模板组ID,最多10个 group_name 否 Array of strings 转码模板组名,最多10个 page 否 Integer 分页编号。查询指定“group_id”时,该参数无效。 默认值:0。 size 否 Integer 每页记录数。取值范围:[1,100],指定group_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 查询转码模板组成功。 { "total" : 1, "template_group_list" : [ { "group_id" : "397565a34913415c91955254add0461a", "name" : "test_templageGroup", "template_ids" : [ 276195 ], "videos" : [ { "template_id" : 276195, "width" : 854, "height" : 480, "bitrate" : 500 } ], "audio" : { "output_policy" : "transcode", "codec" : 1, "bitrate" : 0, "sample_rate" : 1, "channels" : 2 }, "video_common" : { "output_policy" : "transcode", "codec" : 1, "profile" : 3, "level" : 15, "preset" : 3, "max_iframes_interval" : 5, "bframes_count" : 4, "frame_rate" : 0, "black_cut" : 0 }, "common" : { "PVC" : false, "hls_interval" : 5, "dash_interval" : 5, "pack_type" : 4 } } ] } 状态码: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_group/transcodings 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参考“获取项目ID”章节。 表2 Query参数 参数 是否必选 参数类型 描述 group_id 否 Array of strings 转码模板组ID,最多10个 group_name 否 Array of strings 转码模板组名,最多10个 page 否 Integer 分页编号。查询指定“group_id”时,该参数无效。 默认值:0。 size 否 Integer 每页记录数。取值范围:[1,100],指定group_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方式认证时必选,请求的发生时间。
共100000条