获取TTS语音合成任务记录 - ShowTtsJob
功能介绍
该接口用于获取TTS语音合成任务记录。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/ttsc/tts-jobs
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID,获取方法请参考获取项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
每页显示的条目数量。 取值范围: 1~100 默认取值: 10 |
|
offset |
否 |
Integer |
偏移量,表示从此偏移量开始查询。 取值范围: 0~2147483647 默认取值: 0 |
|
create_since |
否 |
String |
过滤创建时间>=输入时间的记录。 |
|
create_until |
否 |
String |
过滤创建时间<=输入时间的记录。 |
|
job_id |
否 |
String |
任务ID。 |
|
job_type |
否 |
String |
任务类型。
|
|
tts_service_enum |
否 |
String |
tts版本。
|
|
business_type |
否 |
String |
业务类型。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Integer |
总记录数。 取值范围: 0~2147483647 |
|
data |
Array of TtsJobDetail objects |
语音合成任务列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
|
need_timestamp |
Boolean |
是否需要时间戳。false为不需要,true为需要返回时间戳信息。默认值为false。 默认取值: false |
|
gen_srt |
Boolean |
是否开启字幕 |
|
job_type |
String |
任务类型。
|
|
job_state |
String |
任务状态。
|
|
fail_msg |
String |
任务合成错误信息 |
|
files |
Array of TtsJobFile objects |
任务合成文件列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
audio_file_url |
String |
音频文件下载链接,有效期为1个小时。 |
|
audio_info_file_url |
String |
时间戳文件下载链接,有效期为1个小时。 |
|
audio_srt_file_url |
String |
字幕文件下载链接,有效期为1个小时。 |
|
audio_action_file_url |
String |
动作分析文件下载链接,有效期为1个小时。 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
业务返回码
|
|
error_msg |
String |
返回描述 |
|
request_id |
String |
请求唯一标识 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
业务返回码
|
|
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"
} ]
} ]
}
SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.metastudio.v1.region.MetaStudioRegion; import com.huaweicloud.sdk.metastudio.v1.*; import com.huaweicloud.sdk.metastudio.v1.model.*; public class ShowTtsJobSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); MetaStudioClient client = MetaStudioClient.newBuilder() .withCredential(auth) .withRegion(MetaStudioRegion.valueOf("<YOUR REGION>")) .build(); ShowTtsJobRequest request = new ShowTtsJobRequest(); try { ShowTtsJobResponse response = client.showTtsJob(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkmetastudio.v1.region.metastudio_region import MetaStudioRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkmetastudio.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = MetaStudioClient.new_builder() \ .with_credentials(credentials) \ .with_region(MetaStudioRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowTtsJobRequest() response = client.show_tts_job(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" metastudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := metastudio.NewMetaStudioClient( metastudio.MetaStudioClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowTtsJobRequest{} response, err := client.ShowTtsJob(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
处理成功。 |
|
400 |
参数异常 |
|
500 |
服务端异常 |
错误码
请参见错误码。