文档

GetVideoTaskInfo - 查询视频合成任务详情

更新时间:

通过提交任务生成的TaskUuid,查询对应视频合成任务详情。同时支持3D数字人和2D数字人的视频合成任务详情查询。

接口说明

根据在成功提交视频合成任务之后获取到的 TaskUuid 可以通过该接口查询视频合成任务状态,由于视频合成任务是离线运行,所以任务执行时间不定,可能需要调用方能够定时调用该接口查询任务状态,直到任务状态为已完成(成功或者失败),针对成功的任务接口会返回任务合成详情, 包含视频和字幕的下载地址,失败的任务会返回失败原因。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
avatar:GetVideoTaskInfoRead
  • 全部资源
    acs:avatar::{#accountId}:*

请求参数

名称类型必填描述示例值
TenantIdlong

从虚拟数字人开放平台中获取的 TenantId

xxxxxx
Appobject

代表一个业务配置

AppIdstring

App ID。在开发者中心-实例管理页面获取对应的 appId,参考文档

3d95xx946a
TaskUuidstring

任务 UUID,提交对应视频生成任务时返回的 TaskUuid。

xxxx-xxxx-xxx

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID

xxx-xxx-xxx-xx
Codestring

错误码

502
Messagestring

错误消息

这是一个错误
Successboolean

调用接口是否成功

  • false: 调用失败。
  • true:调用成功。
true
Dataobject

调用接口结果数据

TaskUuidstring

任务 UUID

xxxx-xxx-xx-xx
Typestring

任务类型:

  • 1: 3D 数字人视频合成。
  • 3: 2D 数字人视频合成。
1
Statusstring

任务业务状态:

  • 1: 等待执行
  • 2: 执行中
  • 3: 成功
  • 4:失败
  • 5: 已取消
  • 6: 已过期
1
Processstring

任务执行进度,暂不支持

99
TaskResultobject

任务结果

VideoUrlstring

视频 URL

注意 有效期 7 天,请尽快下载保存,过期 URL 将失效

xxx/xxxx/xx.mp4
SubtitlesUrlstring

字幕 URL

注意 有效期 7 天,请尽快下载保存,过期 URL 将失效

xxx/xxx/xxx.ass
WordSubtitlesUrlstring

字粒度的时间戳文件,特定任务支持

xxx/xxx/xxx.ass
FailReasonstring

失败原因

这是一个失败原因
FailCodestring

失败错误码

20002
VideoDurationinteger

生成视频时长,单位 ms

60992
AlphaUrlstring

mp4 对应的蒙版视频文件

xxx/xxx/xxx-alpha.mp4
PreviewPicstring

视频首帧预览图

xxxxx.png
AttachmentUrlstring

视频附件地址,特定任务支持

xxx.ini

示例

正常返回示例

JSON格式

{
  "RequestId": "xxx-xxx-xxx-xx",
  "Code": "502",
  "Message": "这是一个错误",
  "Success": true,
  "Data": {
    "TaskUuid": "xxxx-xxx-xx-xx",
    "Type": "1",
    "Status": "1",
    "Process": "99",
    "TaskResult": {
      "VideoUrl": "xxx/xxxx/xx.mp4",
      "SubtitlesUrl": "xxx/xxx/xxx.ass",
      "WordSubtitlesUrl": "xxx/xxx/xxx.ass",
      "FailReason": "这是一个失败原因",
      "FailCode": "20002",
      "VideoDuration": 60992,
      "AlphaUrl": "xxx/xxx/xxx-alpha.mp4",
      "PreviewPic": "xxxxx.png",
      "AttachmentUrl": "xxx.ini"
    }
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-10-24OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-08-28OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-08-01OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-06-07OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-03-08OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-08-18API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (0)