# 查询视频制作任务列表 - ListDigitalHumanVideo #### 功能介绍 该接口用于查询视频制作任务列表。可查询分身数字人视频制作列表，照片数字人视频制作列表等。 ![](https://support.huaweicloud.com/api-metastudio/public_sys-resources/note_3.0-zh-cn.png) - 默认查询最近一个月任务记录。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-metastudio/metastudio_02_0002.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-metastudio/metastudio_02_0071.html)。 #### URI GET /v1/{project_id}/digital-human-videos 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方法请参考[获取项目ID](https://support.huaweicloud.com/api-metastudio/metastudio_02_0006.html)。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 否 | Integer | 偏移量，表示从此偏移量开始查询。 **取值范围：** 0\~2147483647 **默认取值：** 0 | | limit | 否 | Integer | 每页显示的条目数量。 **取值范围：** 1\~100 **默认取值：** 10 | | state | 否 | String | 任务状态，默认所有状态。 可多个状态查询，使用英文逗号分隔。 如state=CREATING,PUBLISHED | | sort_key | 否 | String | 排序字段，支持的排序方式有： - 按创建时间排序：create_time - 按更新时间排序：update_time - 按资产排序：asset_order | | sort_dir | 否 | String | 排序方式。 - asc：升序 - desc：降序 默认asc升序。 | | create_until | 否 | String | 过滤创建时间\<=输入时间的记录。 | | create_since | 否 | String | 过滤创建时间\>=输入时间的记录。 | | fuzzy_query_field | 否 | Array of strings | 使用模糊查询的字段 | | script_id | 否 | String | 剧本ID。 | | asset_name | 否 | String | 输出视频资产名称。 | | job_type | 否 | String | 任务类型。 - 2D_DIGITAL_HUMAN_VIDEO: 分身数字人视频制作任务 - PHOTO_DIGITAL_HUMAN_VIDEO: 照片数字人视频制作任务 | | job_id | 否 | String | 任务ID。 | | job_ids | 否 | Array of strings | 批量查询的任务ID | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 否 | String | 用户Token。使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取。 响应消息头中X-Subject-Token的值。 | | Authorization | 否 | String | 使用AK/SK方式认证时必选，携带的鉴权信息。 | | X-Sdk-Date | 否 | String | 使用AK/SK方式认证时必选，请求的发生时间。 格式为(YYYYMMDD'T'HHMMSS'Z')。 | | X-Project-Id | 否 | String | 使用AK/SK方式认证时必选，携带项目ID信息。 | | X-App-UserId | 否 | String | 第三方用户ID。不允许输入中文。 | #### 响应参数 **状态码：200** 表4响应Header参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | X-Request-Id | String | 请求ID。 | 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | count | Integer | **参数解释**： 视频制作任务总数。 **取值范围：** 0\~2147483647 | | jobs | Array of [DigitalHumanVideo] objects | 视频制作任务列表。 | 表6DigitalHumanVideo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | job_id | String | 任务ID。 | | state | String | 任务的状态。 - WAITING：等待 - PROCESSING：处理中 - SUCCEED：成功 - FAILED：失败 - CANCELED：取消 - BLOCK: 冻结 | | job_type | String | 任务类型。 - 2D_DIGITAL_HUMAN_VIDEO: 分身数字人视频制作任务 - DIGITAL_HUMAN_PHOTO_VIDEO: 照片数字人视频制作任务 | | start_time | String | 数字人视频制作开始时间。 | | end_time | String | 数字人视频制作结束时间。 | | duration | Float | **参数解释**： 数字人视频内容时长。 **取值范围：** 0\~2147483647 | | output_asset_config | [OutputAssetInfo] object | 输出资产信息。 | | error_info | [ErrorResponse] object | 错误信息。 | | create_time | String | 任务创建时间。 | | lastupdate_time | String | 任务更新时间。 | 表7OutputAssetInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | asset_id | String | 输出视频资产ID。 | | asset_name | String | 输出视频资产名称。 | | cover_url | String | 视频封面URL。 | | preview_video_url | String | 预览视频下载URL。URL有效期24小时。 说明： - 分身数字人视频制作不支持预览。 | 表8ErrorResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | **状态码：400** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | **状态码：401** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | **状态码：404** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | **状态码：500** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | #### 请求示例 ``` GET https://{endpoint}/v1/0d697589d98091f12f92c0073501cd79/digital-human-videos ``` #### 响应示例 **状态码：200** 处理成功返回。 ``` { "count" : 1, "jobs" : [ { "job_id" : "26f06524-4f75-4b3a-a853-b649a21aaf66", "state" : "SUCCEED", "start_time" : "2022-01-18T16:29:36Z", "end_time" : "2022-01-18T16:30:36Z", "duration" : 60, "output_asset_config" : { "asset_id" : "942e65a5fd219a2e01fb08d881cfadb9", "asset_name" : "One Day", "cover_url" : "https://{endpoint}/0d697589d98091f12f92c0073501cd79/942e65a5fd219a2e01fb08d881cfadb9/20d367508e62d3d4ad608cedbe81bd35.png?AccessKeyId=xxxxxxxxxx&Expires=1671241457&Signature=xxxxxxxxxxxxxxxx" }, "error_info" : null, "create_time" : "2022-11-30T06:59:56Z", "lastupdate_time" : "2022-11-30T07:00:09Z" } ] } ``` **状态码：400** 请求传参异常，包含错误码及对应描述。 ``` { "error_code" : "MSS.00000003", "error_msg" : "Invalid parameter" } ``` **状态码：401** 未鉴权或鉴权失败。 ``` { "error_code" : "MSS.00000001", "error_msg" : "Unauthorized" } ``` **状态码：404** 无内容。 ``` { "error_code" : "MSS.00000002", "error_msg" : "Not Found" } ``` **状态码：500** 内部服务错误。 ``` { "error_code" : "MSS.00000004", "error_msg" : "Internal Error" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 处理成功返回。 | | 400 | 请求传参异常，包含错误码及对应描述。 | | 401 | 未鉴权或鉴权失败。 | | 404 | 无内容。 | | 500 | 内部服务错误。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-metastudio/ErrorCode.html)。