# 获取TTS语音合成任务记录 - ShowTtsJob #### 功能介绍 该接口用于获取TTS语音合成任务记录。 #### 调用方法 请参见[如何调用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}/ttsc/tts-jobs 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方法请参考[获取项目ID](https://support.huaweicloud.com/api-metastudio/metastudio_02_0006.html)。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | 每页显示的条目数量。 **取值范围：** 1\~100 **默认取值：** 10 | | offset | 否 | Integer | 偏移量，表示从此偏移量开始查询。 **取值范围：** 0\~2147483647 **默认取值：** 0 | | create_since | 否 | String | 过滤创建时间\>=输入时间的记录。 | | create_until | 否 | String | 过滤创建时间\<=输入时间的记录。 | | job_id | 否 | String | 任务ID。 | | job_type | 否 | String | 任务类型。 - AUDITION：试听任务 - ASYNC_JOB：异步任务 - WEBSOCKET：websocket接口合成任务 | | tts_service_enum | 否 | String | tts版本。 - TTS_LLM: 530大模型（V7版本） - TTS_LLM_VC：530大模型VC版本（V7版本） - TTS_LAB：lab小模型（V5版本） - TTS_LAB_GPU：lab小模型GPU版本（V5版本） - GPU_CLONE：V4模型 - TTS_LLM_VQ：VQ模型（V10版本） | | business_type | 否 | String | 业务类型。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 否 | String | 用户Token。使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取。 响应消息头中X-Subject-Token的值。 | | Authorization | 否 | String | 使用AK/SK方式认证时必选，携带的鉴权信息。 | | X-Sdk-Date | 否 | String | 使用AK/SK方式认证时必选，请求的发生时间。 | | X-Project-Id | 否 | String | 使用AK/SK方式认证时必选，携带项目ID信息。 | | X-App-UserId | 否 | String | 第三方用户ID。不允许输入中文。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | count | Integer | 总记录数。 **取值范围：** 0\~2147483647 | | data | Array of [TtsJobDetail] objects | 语音合成任务列表。 | 表5TtsJobDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | job_id | String | 任务ID。 | | websocket_job_id | String | websocket任务ID。 | | asset_id | String | 音色ID | | tts_service_enum | String | 声音版本 | | text_length | Integer | 文本长度 **取值范围：** 1\~10000 | | create_time | String | 任务创建时间。 | | audio_format | String | 输出音频文件格式。默认WAV。 - WAV：wav格式。 - MP3：mp3格式。 - PCM：pcm格式。 **默认取值：** WAV | | need_timestamp | Boolean | 是否需要时间戳。false为不需要，true为需要返回时间戳信息。默认值为false。 **默认取值：** false | | gen_srt | Boolean | 是否开启字幕 | | job_type | String | 任务类型。 - PRELOAD：预加载任务 - WEBSOCKET：websocket接口任务 - ASYNC_JOB：异步任务 - AUDITION：试听任务 | | job_state | String | 任务状态。 - WAITING：等待中 - PROCESSING：合成中 - FAILED：合成失败 - SUCCEED：合成成功 | | fail_msg | String | 任务合成错误信息 | | files | Array of [TtsJobFile] objects | 任务合成文件列表。 | 表6TtsJobFile | 参数 | 参数类型 | 描述 | |:---|:---|:---| | audio_file_url | String | 音频文件下载链接，有效期为1个小时。 | | audio_info_file_url | String | 时间戳文件下载链接，有效期为1个小时。 | | audio_srt_file_url | String | 字幕文件下载链接，有效期为1个小时。 | | audio_action_file_url | String | 动作分析文件下载链接，有效期为1个小时。 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 业务返回码 - MSS.000000001 - 失败 - MSS.000000002 - 内部错误 - MSS.000000003 - 非法参数 - MSS.000000004 - 非法访问，未鉴权或者鉴权失败 | | error_msg | String | 返回描述 | | request_id | String | 请求唯一标识 | **状态码：500** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 业务返回码 - MSS.000000001 - 失败 - MSS.000000002 - 内部错误 - MSS.000000003 - 非法参数 - MSS.000000004 - 非法访问，未鉴权或者鉴权失败 | | error_msg | String | 返回描述 | | request_id | String | 请求唯一标识 | #### 请求示例 ``` GET https://{endpoint}/v1/3f0924078d1b471c884a5383d4dec9fa/ttsc/tts-jobs ``` #### 响应示例 **状态码：200** 处理成功。 ``` { "count" : 1, "data" : [ { "asset_id" : "98263xxxxxx34253880a6ff431xxxxxx", "text_length" : 3492, "job_type" : "WEBSOCKET", "job_state" : "SUCCEED", "files" : [ { "audio_file_url" : "https://xxx" } ] } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 处理成功。 | | 400 | 参数异常 | | 500 | 服务端异常 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-metastudio/ErrorCode.html)。