华为云用户手册

响应参数 表5 响应消息参数说明 参数名称 是否必选 参数类型 默认值 说明 resultcode 是 String(1-32) 无 请求返回的结果码。 resultdesc 是 String(1-128) 无 请求返回的结果描述。 sessionId 是 String(1-256) 无 请求返回的会话sessionId，用于标记一路会话。如果请求失败，则sessionId为空表示会话建立失败。 idlePort 否 Integer 无 请求参数中returnIdlePort为true时响应消息携带该参数。 该参数表示平台呼叫端口空闲可用数量，取值范围0~65535。

请求参数 表2 请求Headers参数说明 参数名称 是否必选 参数类型 说明 Content-Type 是 String 固定填写为application/json;charset=UTF-8。 Authorization 是 String 固定填写为AKSK realm="SDP",profile="UsernameToken",type="Appkey"。 X-AKSK 是 String 取值为UsernameToken Username="APP_Key的值", PasswordDigest="PasswordDigest的值", Nonce="随机数", Created="随机数生成时间"。 PasswordDigest：根据PasswordDigest = Base64 (HMAC-SHA256 (Password，Nonce + Created))生成。其中，Password为APP_Secret的值。Nonce、Created、Password直接进行字符串拼接即可，无需包含+号和空格。 Nonce：客户发送请求时生成的一个随机数，长度为1~128位，可包含数字和大小写字母。例如：66C92B11FF8A425FB8D4CCFE0ED9ED1F。 Created：随机数生成时间。采用UTC+8(北京时间)格式，例如：2018-02-12T15:30:20Z。不同编程语言中将UTC时间戳转换为普通时间时使用的格式不同，部分语言可参考表3。 表3 不同编程语言的时间格式 编程语言 时间格式 Java yyyy-MM-dd'T'HH:mm:ss'Z' PHP Y-m-d\TH:i:s\Z Python %Y-%m-%dT%H:%M:%SZ C# yyyy-MM-ddTHH:mm:ssZ Node.js toISOString().replace(/.[0-9]+\Z/, 'Z') 注：Node.js中，使用toISOString()转换后的时间格式去除毫秒后即为本接口要求的时间格式。 表4 请求Body参数说明 参数名称 是否必选 参数类型 默认值 说明 displayNbr 是 String(4-31) 无 此字段定义主叫用户收到语音通话平台的呼叫时，主叫用户手机终端的来电显示号码。需提前在订购号码页面申请该号码。 号码格式（固话）：国家码+区号+固话，与号码管理页面的“固话号码”保持一致。 若该号码为“暂停”状态，语音通话平台会从该应用下随机选取一个其他可用的固话号码进行外呼。 callerNbr 是 String(4-31) 无 此字段定义用户在SP开发的应用中，通过语音回呼功能发起呼叫时所使用的主叫号码。 手机号码格式：+{国家码}{手机号码}。示例：+86135***0002。 固话格式：+{国家码}{区号}{固话号码}，其中区号需去掉首位的0。示例：国家码86，区号0755，固话号码28****02，填写为+8675528****02。 displayCalleeNbr 是 String(4-31) 无 此字段定义被叫用户收到语音通话平台的呼叫时，被叫用户终端的来电显示号码。需提前在订购号码页面申请该号码。 该号码可以与displayNbr配置为同一个号码，也可以配置为不同号码。 号码格式（固话）：国家码+区号+固话，与号码管理页面的“固话号码”保持一致。 若该号码为“暂停”状态，语音通话平台会从该应用下随机选取一个其他可用的固话号码进行外呼。 calleeNbr 是 String(4-31) 无 此字段定义终端用户在SP开发的应用中通过语音回呼业务发起呼叫时所拨打的被叫号码。 号码格式： 手机号码格式：+{国家码}{手机号码}。示例：+86135****0004。 固话格式：+{国家码}{区号}{固话号码}，其中区号需去掉首位的0。示例：国家码86，区号0755，固话号码28****04，填写为+8675528****04。 maxDuration 否 Integer 0 此字段用于设置允许单次通话进行的最长时间，通话时间从被叫接通的时刻开始计算。 取值范围：0~1440分钟 0：系统不主动结束通话，由主被叫双方结束通话。 1~1440：当通话时长达到此配置值，系统主动结束通话。 不携带时，参数值默认为0。 lastMinVoice 否 String(1-128) 无 当maxDuration字段设置为非0时此参数有效。 此参数用于设置最后一分钟放音提示音，此值填写SP定制的放音文件名，例如lastmin_voice1.wav，参数取值有以下两种场景： SP无需定制个性化放音，无需配置此参数，系统将使用默认放音文件，放音内容为：“本次通话时长还剩1分钟”。 SP需要定制个性化放音，接口消息中携带此参数，参数值携带定制的放音文件名，请提前制作放音文件并通过放音文件管理页面提交到语音通话平台。 lastMinToUE 否 String（枚举） both 当maxDuration字段设置为非0时此参数有效。 此字段用于设置最后一分钟放音的播放对象。 toa：仅对主叫用户放音。 tob：仅对被叫用户放音。 both：同时给主叫和被叫用户放音。 不携带时，参数值默认为both。 playPreVoice 否 String（枚举） false 此字段用于设置主叫（callerNbr）应答语音回呼后，呼叫被叫（calleeNbr）前，是否向主叫（callerNbr）播放提示音。 当该参数设置为true时，播放完主叫提示音（preVoice）后才播放主叫等待音（waitVoice）并呼叫被叫（calleeNbr）。 true：播放提示音。 false：不播放提示音。 不携带时，参数值默认为false。 preVoice 否 String(1-128) 无 当playPreVoice字段设置为true时此参数有效。 此字段用于设置主叫（callerNbr）应答语音回呼后，呼叫被叫（calleeNbr）前向主叫播放的提示音，此值填写放音文件名，例如pre_voice1.wav。 SP无需定制个性化放音文件，接口消息中无需携带此参数，系统将使用默认放音“正在为您转接中，请稍后”。 SP需要定制个性化放音文件，接口消息中携带此参数，请提前制作放音文件并通过放音文件管理页面提交到语音通话平台。 waitVoice 否 String(1-128) 无 此字段用于设置主叫应答语音回呼后的等待音，此值填写放音文件名，例如wait_voice1.wav。 SP无需定制个性化放音文件，接口消息中无需携带此参数，系统将使用默认放音，系统边给主叫放音（循环放音）边拨打被叫用户；被叫应答才中止放音。 SP需要定制个性化放音文件，接口消息中携带此参数，请提前制作放音文件并通过放音文件管理页面提交到语音通话平台。 waitVoice可结合calleeMedia使用。 calleeMedia 否 String（枚举） all 该参数用于指定被叫的媒体音播放方式，参数取值范围如下： all：透传被叫端的所有放音。当被叫端返回振铃音等媒体音，则终止主叫的等待音，播放被叫的媒体音，如彩铃音等。 none：不透传被叫所有放音，一直播放主叫的等待音，直到被叫应答或挂机。 fail：只有在被叫回失败放音时（带reason原因值），才终止主叫的等待音、播放被叫的失败放音。 不携带时，参数值默认为all。 statusUrl 否 String(1-128) 无 此参数请采用BASE64编码进行加密。 此字段用于设置SP接收状态上报的URL。 语音通话平台将业务触发过程中通话的状态信息（包括呼出、振铃、摘机和挂机信息）推送至此服务器，SP根据通话状态信息确定用户状态。 URL可填写为https://IP:Port或 域名 ，推荐使用域名。且该域名对应多个服务器，避免单点故障无法接收通知。 URL只能由大小写字母（a-z、A-Z），数字（0-9），中划线（-），英文冒号（:），英文点号（.），以及英文斜杠（/）组成，不支持其它字符。最大128字节。 feeUrl 否 String(1-128) 无 此参数请采用BASE64编码进行加密。 此参数用于设置SP接收话单上报的URL。 语音通话平台将业务产生的话单推送至此服务器。 URL可填写为https://IP:Port或域名，推荐使用域名。且该域名对应多个服务器，避免单点故障无法接收话单。 URL只能由大小写字母（a-z、A-Z），数字（0-9），中划线（-），英文冒号（:），英文点号（.），以及英文斜杠（/）组成，不支持其它字符。最大128字节。 recordFlag 否 String（枚举） false 此字段设置语音回呼通话过程是否录音。 true：开启录音，请在添加应用时开启录音功能。 false：不开启录音。 不携带时，参数值默认为false。 recordHintTone 否 String(1-128) 无 此字段在recordFlag为true时才有效。 此字段用于设置使用录音功能的提示音，参数传值为指定的放音文件名，例如recordhint_voice1.wav。 无需定制个性化放音时，接口消息中无需携带此参数。 需要定制个性化放音文件时，接口消息中携带此参数，请提前制作放音文件并通过放音文件管理页面提交到语音通话平台。 partyTypeRequiredInDisconnect 否 String(枚举) false 该参数用于指定语音通话平台给开发者发送disconnect的呼叫状态时，通知消息是否需要携带通话主动挂机的用户类型（主叫挂机、被叫挂机、平台挂机）。 该参数取值范围如下： true：需要携带 false：不需要携带 不携带该参数时，默认值为false。 returnIdlePort 否 String(枚举) false 指示是否需要返回平台空闲呼叫端口数量。 true：需要返回 false：不需要返回 不携带该参数时，默认值为false。 userData 否 String(1-256) 无 此字段用于SP开发者自定义呼叫发起时，设置用户的附属信息，应用场景可以是当开发者想要对每一次呼叫的用户进行跟踪时，该参数可以携带用于标识用户的信息，如customerId123。 语音通话平台不对此参数做强制要求，如果开发者传入此参数，语音通话平台会在后续发给SP的通知消息中携带该参数值。 不允许携带以下字符：“{”，“}”（即大括号）。 不允许包含中文字符，如果包含中文字符请采用Base64编码。

使用说明 前提条件 已通过“应用管理”页面获取该语音回呼能力的APP_Key，APP_Secret和APP接入地址。 已通过“号码订购”页面向语音通话平台申请以下号码： 若使用定制化主叫端来电显示号码，请确认已申请固话号码（displayNbr）。 若需隐藏主叫号码，使用定制化被叫端来电显示号码，请确认已申请固话号码（displayCalleeNbr）。 若需使用通话录音功能，请确认已向语音通话平台申请该功能。 若使用个性化放音，请确认已按要求制作并通过放音文件管理页面向语音通话平台提交放音文件，包括最后一分钟提示音（lastMinVoice），主叫提示音（preVoice），主叫等待音（waitVoice），录音提示音（recordHintTone），回呼提示音（callBackTone）。 若需订阅呼叫状态和话单通知，请确认已通过应用管理向语音通话平台提交呼叫状态通知URL（statusUrl）和话单通知URL（feeUrl）。若未提交，调用接口时填写也可以。 注意事项 无。 使用限制 无。

通过Intellij IDEA插件市场安装CodeArts 盘古助手 打开Intellij IDEA，选择“File”，单击“Settings”。 图1 打开设置界面 选择“Plugins”，单击“Marketplace”，并在搜索框中输入Huawei Cloud CodeArts 盘古助手。 图2 搜索CodeArts 盘古助手插件 单击“Install”按钮安装CodeArts 盘古助手插件，弹出需要安装Huawei Cloud Toolkit Platform 。 华为云插件依赖统一华为云开发者生态底座Huawei Cloud Toolkit Platform进行登录，此为必选项。 图3 确认依赖是否安装 单击“Install”继续安装。Intellij IDEA将下载并自动安装插件，等待插件安装完成后，单击“Restart IDE”，或手动重新启动IDE使插件安装生效。 重启IDE完成后，在IDE面板右侧，可以看到“CodeArts 盘古助手”工具窗口。 图4 安装完成后IDE界面

通过本地文件方式安装CodeArts 盘古助手 进入JetBrains插件市场-CodeArts 盘古助手，在“Versions”标签页下选择最新版本，单击“Download”，下载离线安装包。 打开“Intellij IDEA”，选择“File”，单击“Settings”。 图5 打开设置界面 选择“Plugins”，单击齿轮图标，选择“Install Plugin from Disk…”。 图6 选择从磁盘安装 选择下载的安装包路径，选择CodeArts 盘古助手安装包，单击“OK”。 Intellij IDEA将会检查依赖，并完成安装。插件安装完成后，单击“Restart IDE”，或手动重新启动IDE使插件安装生效。 图7 安装完成后确认待重启IDE 重新启动IDE完成后，在IDE面板右侧，可以看到“CodeArts 盘古助手”工具窗口。 图8 安装完成后IDE界面

前提条件 CodeArts 盘古助手插件依赖华为云底座插件“Huawei Cloud Toolkit Platform”，请参考底座插件介绍，完成“Huawei Cloud Toolkit Platform”插件安装。 进入CodeArts 盘古助手申请试用说明页面，单击“申请试用”按钮（当前仅支持 IAM 租户进行申请），等待CodeArts 盘古助手服务支持授权试用。 已下载并安装IntelliJ IDEA 2021.3或更高版本。

通过本地文件安装CodeArts 盘古助手 进入CodeArts IDE插件市场，查看“CodeArts 盘古助手”插件详情，单击“Download Extension”下载插件。 图1 CodeArts 盘古助手插件详情 在“CodeArts IDE”右上角单击“扩展”打开扩展管理。 图2 CodeArts IDE扩展管理 单击图标，选择从本地安装。 图3 选择从本地安装 在文件浏览器中选中“CodeArts 盘古助手”插件文件“huaweicloud.codearts-snap-2.0.1.carts”，单击“安装”。 图4 文件浏览器 CodeArts IDE弹出“非受信任扩展安装提示”，单击“去扩展市场查找”或“取消”跳出安装。单击“继续安装”进入下一步。 “CodeArts IDE”完成安装后弹出安装成功提示，同时弹出CodeArts 盘古助手免责声明。 图5 免责声明 根据您的意愿是否“同意”免责声明，同意即可使用插件，关闭将无法使用插件。

创建知识库资产 单击已创建好的知识库卡片，可进入当前知识库新建资产页面。 单击页面左上角“新建资产”，弹出新建资产对话框。 图1 新建资产对话框 填写资产名称，上传相应的文档。当前上传文件只支持本地文件和代码文件两种文件类型。 单击下一步，进入入库配置页面。选择一个Embedding模型，对上传的文档进行向量化，当前提供四个模型可供选择。 图2 入库配置页面 在入库配置页面，按需配置“高级配置”中的“分段预计长度”。 单击“确定”，知识库资产创建完毕，如图3所示，为创建好的知识库资产列表。 图3 知识库资产列表

约束与限制 上传文档限制 本地文件：支持TXT、DOCX格式文件，单个文件最大支持20MB。 代码文件：仅支持JAVA、PYTHON、C、C++文件的ZIP格式，单个文件最大支持20MB，单个资产配额50MB。 入库配置限制 中文文本嵌入模型m3e-base：该模型是适用于中英文文本的通用型768维度的嵌入模型。 中文版文本表示模型bge-large-zh-v1.5：该模型适用于检索、分类、聚类或语义匹配等任务，目前仅支持中文文本。 向量计算模型paraphrase-multilingual-MiniLM-L12-v2：该模型适用于中英文文本，在文本相似度计算中表现优异，模型维度364。 华为自研代码专用模型VESO-v1.2：该模型在代码数据向量化、代码搜索任务中表现突出。 高级配置 切分器：不同的切分器的切片方式和结果不同，在不同的语言场景下可以选择不同的切分器，当前只支持中文切分器。 分段预计长度：分片长度的取值范围为50-1000，默认值为300。

请求参数 表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参数 参数 是否必选 参数类型 描述 project_id 否 String 委托任务租户ID operate_type 是 String 操作标记 取值范围为[CREATED,CANCELED] CREATED：表示授权 CANCELED：表示取消授权

响应示例 状态码：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时该参数无效。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 objects Array of ObsObject objects 返回的OBS对象组详情 表5 ObsObject 参数 参数类型 描述 file_name String 对象的key size Long 文件大小 last_modified String 文件的最后修改时间 状态码：400 表6 响应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方式认证时必选，请求的发生时间。

响应示例 状态码：200 查询转码服务端事件通知配置成功。 { "total" : 7, "notifications" : [ { "event_name" : "RemuxComplete", "status" : "on", "topic" : "urn: smn:region1:tenantId:topic", "msg_type" : 3 }, { "event_name" : "AnimatedGraphicsComplete", "status" : "on", "topic" : "urn: smn:region1:tenantId:topic", "msg_type" : 3 }, { "event_name" : "TranscodeComplete", "status" : "on", "topic" : "urn: smn:region1:tenantId:topic", "msg_type" : 3 }, { "event_name" : "ThumbnailComplete", "status" : "off", "topic" : "urn: smn:region1:tenantId:topic", "msg_type" : 3 }, { "event_name" : "TranscodeStart", "status" : "on", "topic" : "urn: smn:region1:tenantId:topic", "msg_type" : 3 }, { "event_name" : "ParseComplete", "status" : "on", "topic" : "urn: smn:region1:tenantId:topic", "msg_type" : 3 }, { "event_name" : "EditingComplete", "status" : "on", "topic" : "urn: smn:region1:tenantId:topic", "msg_type" : 3 } ] } 状态码：400 查询转码服务端事件通知配置失败。 { "error_code" : "MPC.10208", "error_msg" : "Failed to verify the tenant ID." }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 notifications Array of Notification objects 事件通知模板信息 total Integer 事件通知模板总数 表4 Notification 参数 参数类型 描述 event_name String 消息事件的名称 status String 事件通知模板选中状态 topic String 事件通知主题的URN msg_type Integer 订阅消息类型 状态码：400 表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方式认证时必选，请求的发生时间。

请求参数 表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时，只需指定到转码结果期望存放的路径。 在字幕场景下，字幕文件名称中禁止携带特殊符号，否则会导致转码任务失败，如：[ 正确示例: demo.srt 错误示例: [demo.srt file_name 否 String 文件名，文件名长度不能超过180个字符。 当指定了此参数时，输出的对象名为object/file_name。 当不指定此参数时，输出的对象名为object/xxx，其中xxx由MPC指定。 在作为输出文件名时： 在转封装场景有效，需要指定输出文件名称 在转码场景下，如果需要指定输出的文件名称，请使用output_filenames参数 在解析场景有效，解析场景如果指定文件名，则将解析参数写入指定文件名，通过查询接口响应json数据获取文件元数据信息 在截图场景无效 在转动图场景无效 输出文件为HLS格式时，文件名称不能命名为index，示例：index.m3u8，否则会导致播放失败。 表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]

请求示例 创建动图任务，用于将完整的视频文件或视频文件中的一部分转换为动态图文件，暂只支持输出GIF文件。 POST https://{endpoint}/v1/{project_id}/animated-graphics { "input" : { "bucket" : "example-bucket", "location" : "region01", "object" : "example-path/input.mp4" }, "output" : { "bucket" : "example-bucket", "location" : "region01", "object" : "example-path/output", "file_name" : "test_mpc.gif" }, "output_param" : { "format" : "gif", "width" : 480, "height" : 360, "frame_rate" : 15, "start" : 100, "end" : 250 } }

响应示例 状态码：200 查询转封装任务成功。 { "total" : 1, "tasks" : [ { "task_id" : 10743, "error_code" : "MPC.10218", "status" : "SUCCEED", "create_time" : 20201117021558, "start_time" : 20201117021558, "end_time" : 20201117021559, "description" : "The task has completed.", "input" : { "bucket" : "example-bucket", "location" : "region01", "object" : "example-path/input.flv" }, "output" : { "bucket" : "example-bucket", "location" : "region01", "object" : "example-path/output.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." }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 total Integer 任务总数 tasks Array of RemuxTask objects 任务列表 表5 RemuxTask 参数 参数类型 描述 task_id String 任务ID status String 任务状态。 取值如下： INIT：初始状态。 WAITING：等待启动。 PRO CES SING：处理中。 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时，只需指定到转码结果期望存放的路径。 在字幕场景下，字幕文件名称中禁止携带特殊符号，否则会导致转码任务失败，如：[ 正确示例: demo.srt 错误示例: [demo.srt file_name String 文件名，文件名长度不能超过180个字符。 当指定了此参数时，输出的对象名为object/file_name。 当不指定此参数时，输出的对象名为object/xxx，其中xxx由MPC指定。 在作为输出文件名时： 在转封装场景有效，需要指定输出文件名称 在转码场景下，如果需要指定输出的文件名称，请使用output_filenames参数 在解析场景有效，解析场景如果指定文件名，则将解析参数写入指定文件名，通过查询接口响应json数据获取文件元数据信息 在截图场景无效 在转动图场景无效 输出文件为HLS格式时，文件名称不能命名为index，示例：index.m3u8，否则会导致播放失败。 表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 文件封装格式。 md5 String 视频的 md5 值。 bitrate Long 总码率。 单位：bit/秒 video Array of VideoInfo objects 视频流元数据。 audio Array of AudioInfo objects 音频流元数据。 表9 VideoInfo 参数 参数类型 描述 width Integer 视频宽度 height Integer 视频高度 bitrate Integer 视频码率。 单位: kbit/s 说明： 视频解析接口2024年8月7日做了如下变更： 变更前：视频解析任务，如果为同步解析，即sync参数配置为1时，解析响应VideoInfo中的参数bitrate单位实际为bit/s。 变更后：视频解析任务同步解析响应VideoInfo中的参数bitrate单位变更为kbit/s。 上述更新，可能会影响历史用户的转码业务判断，请关注并及时调整业务。 bitrate_bps Long 视频码率。 单位: bit/s frame_rate Integer 帧率。 取值范围：0或[5,60]，0表示自适应。 单位：帧每秒。 说明： 若设置的帧率不在取值范围内，则自动调整为0，若设置的帧率高于片源帧率，则自动调整为片源帧率。 codec String 视频编码格式 duration String 视频流时长，单位：秒 duration_ms String 视频流时长，单位：毫秒 rotate Float 视频拍摄时的选择角度，单位：度。 表10 AudioInfo 参数 参数类型 描述 codec String 音频编码格式 sample Integer 音频采样率 channels Integer 音频信道 bitrate Integer 音频码率。 单位: kbit/s bitrate_bps Long 音频码率。 单位: bit/s duration String 音频流时长，单位：秒 duration_ms String 音频流时长，单位：毫秒 状态码：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方式认证时必选，请求的发生时间。

URI GET /v1/{project_id}/remux 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 task_id 否 Array of strings 任务ID。一次最多10个 status 否 String 任务执行状态。 取值如下： INIT：初始状态 WAITING：等待启动 PROCESSING：处理中 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。

请求参数 表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}/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 - 新建水印模板。