# 查询视频制作剧本列表 - ListVideoScripts #### 功能介绍 该接口用于查询视频制作剧本列表。 #### 调用方法 请参见[如何调用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-video-scripts 表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 | | name | 否 | String | 按名称模糊查询。 | | script_catalog | 否 | String | 剧本类型。默认查询VIDEO_DRAFT。 - VIDEO_DRAFT：视频草稿。 - SYSTEM_VIDEO_TEMPLET： 系统视频模板。 | | view_mode | 否 | String | 横竖屏类型（内部参数，不对外开放）。默认值是LANDSCAPE。 - LANDSCAPE：横屏。 - VERTICAL：竖屏。 | #### 请求参数 表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 | | video_scripts | Array of [VideoScriptBaseInfo] objects | 剧本列表。 | 表6VideoScriptBaseInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | script_id | String | 剧本ID。 | | script_name | String | 剧本名称。 | | script_description | String | 剧本描述。 | | model_asset_id | String | 数字人模型资产ID，可以从资产库中查询。 | | model_asset_type | String | 数字人模型类型。 - HUMAN_MODEL_2D：分身数字人 | | script_cover_url | String | 剧本封面下载url。 | | script_type | String | 脚本类型，即视频制作的驱动方式。默认TEXT - TEXT: 文本驱动，即通过TTS合成语音 - AUDIO: 语音驱动 | | text | String | 台词脚本。 | | create_time | String | 创建时间，格式遵循：RFC 3339 如"2021-01-10T08:43:17Z"。 | | update_time | String | 更新时间，格式遵循：RFC 3339 如"2021-01-10T08:43:17Z"。 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | **状态码：401** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | **状态码：500** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | #### 请求示例 ``` GET https://{endpoint}/v1/70b76xxxxxx34253880af501cdxxxxxx/digital-human-video-scripts ``` #### 响应示例 **状态码：200** 成功。 ``` { "count" : 1, "video_scripts" : [ { "script_id" : "26f06524-4f75-4b3a-a853-b649a21aaf66", "script_name" : "大自然的传说", "model_asset_id" : "a5d295cdb345c11bd9f36bc22ced3a7a", "script_description" : "课件", "create_time" : "2022-11-30T06:59:55Z", "update_time" : "2022-12-05T12:30:37Z" } ] } ``` **状态码：400** 请求传参异常，包含错误码及对应描述。 ``` { "error_code" : "MSS.00000003", "error_msg" : "Invalid parameter" } ``` **状态码：401** 未鉴权或鉴权失败。 ``` { "error_code" : "MSS.00000001", "error_msg" : "Unauthorized" } ``` **状态码：500** 内部服务错误。 ``` { "error_code" : "MSS.00000004", "error_msg" : "Internal Error" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 成功。 | | 400 | 请求传参异常，包含错误码及对应描述。 | | 401 | 未鉴权或鉴权失败。 | | 500 | 内部服务错误。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-metastudio/ErrorCode.html)。