查询提交的视频合成任务列表,支持分页。支持根据数字人类型、状态、标题进行筛选。已过期和已取消任务不支持查询。
接口说明
支持根据数字人类型、状态、标题进行筛选。已过期和已取消任务不支持查询。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
avatar:QueryVideoTaskInfo | List |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
TenantId | long | 是 | 租户 ID,从虚拟数字人开放平台中获取的 TenantId | xxxxxx |
App | object | 是 | App 信息,代表一个业务配置 | |
AppId | string | 是 | App ID。在开发者中心-实例管理页面获取对应的 appId,参考文档。 | 3d95xx946a |
TaskUuid | string | 否 | 任务 UUID,提交对应视频生成任务时返回的 TaskUuid。 | xxxx-xxxx-xxx |
Title | string | 否 | 要检索的视频任务标题,长度<10 字符 | 测试 |
Type | integer | 否 | 任务类型:
| 1 |
Status | integer | 否 | 任务业务状态,已过期和已取消的任务不支持查询:
不传默认查询全部状态 | 3 |
OrderById | string | 否 | ID 排序规则,支持 asc-正序(最新数据在后)和 desc-倒序(最新数据在前) | desc |
PageNo | integer | 否 | 分页,页数,从 1 开始 | 1 |
PageSize | integer | 否 | 分页,每页数量 | 10 |
返回参数
示例
正常返回示例
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-24 | OpenAPI 返回结构发生变更 | 看变更集 | ||
| ||||
2023-08-28 | OpenAPI 返回结构发生变更 | 看变更集 | ||
|