响应示例 状态码： 200 OK { "templates" : [ { "template_id" : 5, "name" : "web-java-spring", "source" : { "location" : "git@codehub.alpha.devcloud.inhuawei.com:Demo00226/JavaWeb.git", "type" : "git", "parameters" : { } }, "display_name" : "web-java-spring", "path" : "/web-java-spring", "description" : "A basic example using Spring servlets. The app returns\nvalues entered into a submit form.", "project_type" : "maven", "region" : "cn-north-7", "tags" : [ "maven", "spring", "java", "web" ], "arch" : "x86,arm" } ], "status" : "success" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token，使用Token鉴权方式时必选。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Authorization 否 String 使用AK/SK方式认证时必选，携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选，请求的发生时间。 表3 请求Body参数 参数 是否必选 参数类型 描述 id 是 String 水印模板配置id name 是 String 水印模板名称 dx 否 String 水印图片相对输出视频的水平偏移量，默认值是0。 设置方法有两种，建议小数型，整数型可能导致控制台图片无法预览，但不影响转码： 整数型：表示图片起点水平偏移视频顶点的像素值，单位px。取值范围：[0，4096] 小数型：表示图片起点相对于视频分辨率宽的水平偏移比率。取值范围：(0，1)，支持4位小数，如0.9999，超出部分系统自动丢弃。 dy 否 String 水印图片相对输出视频的垂直偏移量，默认值是0。 设置方法有两种，建议小数型，整数型可能导致控制台图片无法预览，但不影响转码： 整数型：表示图片起点垂直偏移视频顶点的像素值，单位px。取值范围：[0，4096] 小数型：表示图片起点相对于视频分辨率高的垂直偏移比率。取值范围：(0，1)，支持4位小数，如0.9999，超出部分系统自动丢弃。 position 否 String 水印的位置，默认TOPRIGHT。 目前包括： TOPRIGHT：右上位置 TOPLEFT：左上位置 BOTTOMRIGHT：右下位置 BOTTOMLEFT：左下位置 width 否 String 水印图片宽，建议小数型，整数型可能导致控制台图片无法预览，但不影响转码。 值有两种形式： 整数型代水印图片宽的像素值，范围[8，4096]，单位px。 小数型代表相对输出视频分辨率宽的比率，范围(0,1)，支持4位小数，如0.9999，超出部分系统自动丢弃。 height 否 String 水印图片高，建议小数型，整数型可能导致控制台图片无法预览，但不影响转码。 值有两种形式： 整数型代表水印图片高的像素值，范围[8，4096]，单位px。 小数型代表相对输出视频分辨率高的比率，范围(0，1)，支持4位小数，如0.9999，超出部分系统自动丢弃。 watermark_type 否 String 水印类型，当前只支持IMAGE（图片水印） image_process 否 String watermark_type设置为IMAGE时有效。 目前包括： ORIGINAL：只做简单缩放，不做其他处理 TRANSPARENT：图片底色透明 GRAYED：彩色图片变灰 timeline_start 否 String 水印开始时间，与"timeline_duration"配合使用。 取值范围:[0, END)。"END"表示视频结束时间。 单位:秒。 timeline_duration 否 String 水印持续时间，与"timeline_start"配合使用。 取值范围:(0,END-开始时间]。"END"表示视频结束时间。 单位:秒。 默认:END。

响应示例 状态码：200 处理成功返回。 { "template_group_list" : [ { "group_id" : "9751249d25f14587b212544d6fd8dcf8", "name" : "non_transcoding_template_group", "is_default" : false, "type" : "non_transcoding_template_group", "is_auto_encrypt" : false, "quality_info_list" : [ { "video" : { "quality" : "UNKNOW", "width" : 0, "height" : 0, "bitrate" : 0, "frame_rate" : 0 }, "audio" : null } ], "watermark_template_ids" : null, "description" : null, "common" : { "pvc" : false, "is_black_cut" : false, "format" : "UNKNOW", "upsample" : false, "adaptation" : "NONE", "video_codec" : null, "audio_codec" : "AAC", "hls_interval" : 0 } } ], "total" : 0 } 状态码：403 处理失败返回。 { "error_code" : "VOD.10053", "error_msg" : "The request parameter is illegal, illegal field: {xx}." }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 template_group_list Array of TransTemplateRsp objects 模板组信息 total Integer 总记录条数 表5 TransTemplateRsp 参数 参数类型 描述 group_id String 模板组id name String 模板组名称 is_default Boolean 是否设置成默认转码模板 type String 模板组类型 is_auto_encrypt Boolean 配置是否加密输出音视频，默认false不加密。 当前只支持加密输出HLS格式的音视频流，不会对原始上传的音视频进行加密处理。非HLS转码输出的音视频格式，此字段不可配置。开启此配置前，请参考《VOD用户指南》的“HLS加密设置”章节获取密钥URL。 quality_info_list Array of QualityInfoList objects 画质配置信息列表 watermark_template_ids Array of strings 绑定的水印模板组ID数组 description String 模板介绍 common CommonInfo object 高清低码开关，高清低码Version，编码格式多路共同参数 表6 QualityInfoList 参数 参数类型 描述 video VideoInfo object 模板视频信息。video和audio至少配置一个参数。 audio AudioInfo object 模板音频信息 表7 VideoInfo 参数 参数类型 描述 quality String 画质 4K默认分辨率3840*2160，码率8000kbit/s 2K默认分辨率2560*1440，码率7000kbit/s FULL_HD默认分辨率1920*1080，码率3000kbit/s HD默认分辨率1280*720，码率1000kbit/s SD默认分辨率854*480，码率600kbit/s FLUENT默认分辨率480*270，码率300kbit/s width Integer 视频宽度 H264编码：0或[32,4096]之间2的整数倍 H265编码：0或[160,4096]之间2的整数倍 height Integer 视频高度 H264编码：0或[32,2880]之间2的整数倍 H265编码：0或[160,2880]之间2的整数倍 bitrate Integer 平均码率，单位：kbit/s。 参考取值范围：0或[40,30000]之间的整数。 frame_rate Integer 帧率，单位是帧每秒。 取值范围：[0-75]之间的整数，小于5帧或大于60帧代表自适应。 表8 AudioInfo 参数 参数类型 描述 sample_rate String 音频采样率（有效值范围） AUDIO_SAMPLE_AUTO (default), AUDIO_SAMPLE_22050：22050Hz AUDIO_SAMPLE_32000：32000Hz AUDIO_SAMPLE_44100：44100Hz AUDIO_SAMPLE_48000：48000Hz AUDIO_SAMPLE_96000：96000Hz bitrate Integer 音频码率（单位：Kbps） channels String 声道数（有效值范围） AUDIO_CHANNELS_1:单声道 AUDIO_CHANNELS_2：双声道 (default) AUDIO_CHANNELS_5_1：5.1声道 表9 CommonInfo 参数 参数类型 描述 pvc Boolean 高清低码开关 video_codec String 视频编码格式 H264 H265 audio_codec String 音频编码格式 AAC：AAC格式 (default) HEAAC1：HEAAC1格式 HEAAC2：HEAAC2格式 MP3：MP3格式 is_black_cut Boolean 黑边剪裁类型，默认false不开启黑边剪裁 format String 转码格式 MP4 HLS DASH DASH_HLS MP3 ADTS UNKNOW hls_interval Integer 分片时长，范围2-10（默认为5秒） upsample Boolean 上采样开关，开启后可以提升视频的分辨率，增加采样点的数量，默认值:false，表示不开启上采样。 adaptation String 转码后的片源分辨率自适应方式。 取值如下： SHORT：短边自适应。转码模板的宽和高都设置，用其中的短边与片源短边对比，然后片源长边按此比例进行缩放。 LONG：长边自适应。转码模板的宽和高都设置，用其中的长边与片源长边对比，然后片源短边按此比例进行缩放。 NONE：按设置宽高适应，为默认值。按照转码模板设置的宽高输出。 说明： V1接口（已废弃）不支持设置该参数，默认按SHORT处理。V2接口默认按NONE处理，V1和V2接口默认值有差异，在调用时需要注意该参数值的设置。 控制台是通过V2接口创建的转码模板，实际与V1接口创建转码模板的默认值保持一致，为SHORT。 preset Integer 编码质量等级，取值[0,2] 0表示默认方式，1表示转码效率优先，2表示转码质量优先。 max_iframes_interval Integer I帧最大间隔，取值范围：[2，10]。默认值：5，单位秒。 hls_audio_separate Boolean 转码后音频是否独立存储。 hls_segment_type String HLS分片的封装格式，目前支持TS和FMP4，默认TS格式 状态码：403 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token，使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Authorization 否 String 使用AK/SK方式认证时必选，携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选，请求的发生时间。

URI GET /v2/{project_id}/asset/template/transcodings 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参考获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 group_id 否 String 模板id is_default 否 Boolean 是否默认模板 offset 否 Integer 偏移量。默认为0。指定group_id时该参数无效。 limit 否 Integer 每页记录数。默认为10，范围[1,100]。指定group_id时该参数无效。 query_string 否 String 按照模板名和描述模糊查询。指定group_id时该参数无效。

相关API 接口名称 调用说明 获取Token 调用该接口获取到Token，再调用其他接口时，需要在请求消息头中添加“Authorization”，其值即为Token。 获取设备列表 调用该接口获取到isdp唯一设备ID。 保存设备模板时，需要输入isdp唯一设备ID。 添加设备 调用该接口添加设备。 修改设备 调用该接口修改设备。 删除设备 调用该接口删除设备。 获取设备信息 调用该接口获取设备信息。

请求参数 参数 类型 是否必填 描述 isdpDeviceIds String 是 isdp唯一设备ID集，List形式 获取isdp唯一设备ID API请参见：摄像头列表查询（好望云平台）（API名称：getDeviceList） templateId Long 是 模板编号 templateCode String 是 模板代码 templateName String 是 模板名称 templateParams String 是 模板参数集，List形式 objectId String 是 审核项编号 objectCode String 是 审核项代码 objectName String 是 审核项名称

请求示例 { "isdpDeviceIds": ["21024125389SL7002176--1","21024125389SL7002178--1"], "templateId": 88888888, "templateCode":"bestDC", "templateName":"bestDC识别对象模板", "templateParams":[ { "objectId":"30", "objectCode":"helmet", "objectName":"安全帽" }, { "objectId":"31", "objectCode":"high_visible_vest", "objectName":"荧光衣" }, { "objectId":"32", "objectCode":"fire", "objectName":"火" }, { "objectId":"33", "objectCode":"smoke", "objectName":"烟" }, { "objectId":"34", "objectCode":"face", "objectName":"人脸" } ] }

响应示例 状态码：200 列举模板版本成功 { "versions" : [ { "template_id" : "69f8d5ea-eaa4-4a3b-a96d-bae9230e97c8", "template_name" : "my_first_template", "version_description" : "当前模板的第二个版本", "create_time" : "2023-05-09T08:01:24Z", "version_id" : "V2" }, { "template_id" : "69f8d5ea-eaa4-4a3b-a96d-bae9230e97c8", "template_name" : "my_first_template", "version_description" : "当前模板的第一个版本", "create_time" : "2023-05-09T08:01:23Z", "version_id" : "V1" } ] }

请求示例 列举当前模板的所有的模板版本信息 GET https://{endpoint}/v1/c364070ab35041ddae68cf8b4839b60f/templates/my_template/versions 列举当前模板的所有的模板版本信息，并提供模板id以校验是否与当前模板匹配 GET https://{endpoint}/v1/c364070ab35041ddae68cf8b4839b60f/templates/my_template/versions?template_id=1b15e005-bdbb-4bd7-8f9a-a09b6774b4b3

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 versions Array of TemplateVersion objects 模板版本列表 表5 TemplateVersion 参数 参数类型 描述 template_id String 模板的唯一ID，由模板服务随机生成 template_name String 用户希望创建的模板名称 version_description String 模板版本的描述。可用于客户识别自己的模板版本 create_time String 版本创建时间，格式遵循RFC3339，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z version_id String 模板模板版本ID 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表7 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表9 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：403 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表11 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：404 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表13 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：429 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表15 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：500 表16 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表17 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息

功能介绍 列举模板版本信息（ListTemplateVersions） 此API用于列举模板下所有的模板版本信息 默认按照生成时间降序排序，最新生成的模板排列在最前面 注意：目前返回全量模板版本信息，即不支持分页 如果没有任何模板版本，则返回空list template_id是模板的唯一Id。此Id由 资源编排 服务在生成模板的时候生成，为UUID。由于模板名仅仅在同一时间下唯一，即用户允许先生成一个叫HelloWorld的模板，删除，再重新创建一个同名模板。对于团队并行开发，用户可能希望确保，当前我操作的模板就是我认为的那个，而不是其他队友删除后创建的同名模板。因此，使用ID就可以做到强匹配。资源编排服务保证每次创建的模板所对应的ID都不相同，更新不会影响ID。如果给予的template_id和当前模板管理的ID不一致，则返回400 如果模板不存在则返回404 ListTemplateVersions返回的信息只包含模板版本摘要信息（具体摘要信息见ListTemplateVersionsResponseBody），如果用户需要了解模板版本内容，请调用ShowTemplateVersionContent

URI GET /v1/{project_id}/templates/{template_name}/versions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，可以从调用API处获取，也可以从控制台获取。 项目ID获取方式 template_name 是 String 用户希望创建的模板名称 表2 Query参数 参数 是否必选 参数类型 描述 template_id 否 String 模板的ID。当template_id存在时，模板服务会检查template_id是否和template_name匹配，不匹配会返回400

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 template_id String 模板的唯一ID，由模板服务随机生成 version_id String 模板模板版本ID 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表6 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表8 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表10 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：409 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表12 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：429 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表14 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：500 表15 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表16 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息