目录

取消异步任务

功能介绍

通过解析MusicXML中的内容进行歌声的合成。您的应用可以通过调用此接口,取消歌声合成异步任务,并删除任务。

场景描述

任务需要进行变更,不需要继续运行原任务时可调用任务取消接口。

使用约束

仅支持合法的32位任务ID,CP只能删除自己创建的任务,当传入的任务ID不存在时也会返回成功。

接口原型

承载协议

HTTPS POST

接口方向

应用服务端 –> 音频编辑服务

URI

{rootUrl}/v1/audioeditor/gateway/ai/ttsing/async/task/cancel

说明:

{rootUrl}在不同站点有不同的URL,具体请参见站点信息。

数据格式

请求消息:Content-Type: application/json

响应消息:Content-Type: application/json

请求参数

Request Header

参数

是否必选

参数类型

描述

X-Request-ID

是

String

请求事务标识,保证唯一即可。

X-Package-Name

是

String

App包名。

X-Country-Code

是

String

App所在归属国家。

HMS-APPLICATION-ID

是

String

App标识,即Client ID。

certFingerprint

是

String

证书指纹。

Authorization

是

String

您动态获取的Access Token。

说明:

Bearer后面拼接空格,再拼接获取的access_token。

Request Body

参数

是否必选

参数类型

描述

taskId

是

String

任务ID。

请求示例

POST /v1/audioeditor/gateway/ai/ttsing/async/task/cancel HTTP/1.1
X-Request-ID: a6596b8a-87b0-4cb3-97fe-45e91432515f
X-Package-Name: com.huawei.demo
X-Country-Code: cn
HMS-APPLICATION-ID: 123456
certFingerprint: xxx
Content-Type: application/json
Authorization: Bearer ***

{
    "taskId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

响应参数

状态码为200时:

Response Header

参数

是否必选

参数类型

描述

Content-Type

是

String

取值为:application/json; charset=UTF-8。

Response Body

参数

是否必选

参数类型

描述

retCode

是

String

详细错误码,请参见错误码。

retMsg

是

String

错误码描述,请参见错误码。

响应示例

HTTP/1.1 200 OK
Content-Type: application/json

{
    "retCode": "0",
    "retMsg": "Success"
}

Postman调试

您可以使用Postman在线调试此接口。