文档

QueryVideoTaskInfo - 查询视频合成任务列表

更新时间:

查询提交的视频合成任务列表,支持分页。支持根据数字人类型、状态、标题进行筛选。已过期和已取消任务不支持查询。

接口说明

支持根据数字人类型、状态、标题进行筛选。已过期和已取消任务不支持查询。

调试

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

授权信息

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

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

请求参数

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

租户 ID,从虚拟数字人开放平台中获取的 TenantId

xxxxxx
Appobject

App 信息,代表一个业务配置

AppIdstring

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

3d95xx946a
TaskUuidstring

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

xxxx-xxxx-xxx
Titlestring

要检索的视频任务标题,长度<10 字符

测试
Typeinteger

任务类型:

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

任务业务状态,已过期和已取消的任务不支持查询:

  • 1: 等待执行
  • 2: 执行中
  • 3: 成功
  • 4:失败

不传默认查询全部状态

3
OrderByIdstring

ID 排序规则,支持 asc-正序(最新数据在后)和 desc-倒序(最新数据在前)

desc
PageNointeger

分页,页数,从 1 开始

1
PageSizeinteger

分页,每页数量

10

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

0A466686-8F3A-55A6-93D8-A0225DC965C0
Successboolean

调用接口是否成功

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

错误码

10010001
Messagestring

错误信息

这是一个错误
Dataobject

调用返回数据

PageNointeger

当前页码

1
PageSizeinteger

每页数量

10
TotalCountlong

总记录数

10
Listobject []

视频合成任务列表

TaskUuidstring

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

789c45a5-2dca-4cd2-8fa7-f70a77e335ad
Titlestring

提交的视频合成的任务标题

测试
Typeinteger

任务类型:

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

任务业务状态:

  • 1: 等待执行
  • 2: 执行中
  • 3: 成功
  • 4:失败
3
TaskResultobject

任务结果

VideoUrlstring

视频 URL

xxx/xxxx/xx.mp4
SubtitlesUrlstring

字幕 URL

xxx/xxx/xxx.ass
WordSubtitlesUrlstring

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

xxx/xxx/xxx.ass
VideoDurationinteger

生成视频时长,单位 ms

1111
FailReasonstring

失败原因

这是一个失败原因
FailCodestring

失败错误码

10001001
AlphaUrlstring

mp4 对应的 alpha 文件

xxx/xxx/xxx-alpha.mp4
PreviewPicstring

视频首帧预览图

xxxxx.png
AttachmentUrlstring

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

xxx.ini

示例

正常返回示例

JSON格式

{
  "RequestId": "0A466686-8F3A-55A6-93D8-A0225DC965C0\n",
  "Success": true,
  "Code": "10010001",
  "Message": "这是一个错误",
  "Data": {
    "PageNo": 1,
    "PageSize": 10,
    "TotalCount": 10,
    "List": [
      {
        "TaskUuid": "789c45a5-2dca-4cd2-8fa7-f70a77e335ad",
        "Title": "测试",
        "Type": 1,
        "Status": 3,
        "TaskResult": {
          "VideoUrl": "xxx/xxxx/xx.mp4\n",
          "SubtitlesUrl": "xxx/xxx/xxx.ass\n",
          "WordSubtitlesUrl": "xxx/xxx/xxx.ass\n",
          "VideoDuration": 1111,
          "FailReason": "这是一个失败原因\n",
          "FailCode": "10001001",
          "AlphaUrl": "xxx/xxx/xxx-alpha.mp4",
          "PreviewPic": "xxxxx.png",
          "AttachmentUrl": "xxx.ini\n"
        }
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-10-24OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-08-28OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)