终止任务（StopTask）--语音服务-火山引擎

文档中心

立即注册

导航

终止任务（StopTask）

最近更新时间：2023.08.17 20:59:13首次发布时间：2023.02.28 20:31:38

终止任务（StopTask）

终止任务

接口说明

请求方式：POST
接口地址：https://cloud-vms.volcengineapi.com?Action=StopTask&Version=2022-01-01

请求参数

Header

参数	数据类型	是否必填	示例值	描述
X-Date	String	是	20201103T104027Z	鉴权字段。请参考文档中心-火山引擎。
Authorization	String	是	HMAC-SHA256 Credential***	鉴权字段。请参考文档中心-火山引擎。
ServiceName	String	是	vms	服务名称。语音服务的服务名称为`vms`。
Region	String	是	cn-north-1	区域名称。
Content-Type	String	是	application/x-www-form-urlencoded	指定请求消息体的结构化格式。

Query

参数	数据类型	是否必填	示例值	描述
Action	String	是	StopTask	接口名称。该接口固定值为`StopTask`。
Version	String	是	2022-01-01	接口版本。

Body（form-data）

参数	数据类型	是否必填	示例值	描述
TaskOpenId	String	是	123	任务唯一标识符

返回参数

参数	数据类型	描述
ResponseMetadata	ResponseMetadata	见 ResponseMetadata

请求示例

TaskOpenId=123

返回示例

{
    "ResponseMetadata":{
        "RequestId":"2021052017361001022509205912000B28",
        "Action":"StopTask",
        "Version":"2022-01-01",
        "Service":"vms",
        "Region":"cn-north-1"
    }
}