文档中心

数据库传输服务

请输入

数据传输

StopTransmissionTask

调用 StopTransmissionTask 接口终止传输任务。

请求类型

同步请求。

注意事项

如果终止的任务状态不是 Running 或 Suspend，那么对应任务接口调用不成功。您可以调用 DescribeTransmissionTasks 接口查看传输任务的详细信息。

终止任务即退订任务，终止后根据任务计费方式的不同，相关费用如下所示：

按量付费：任务终止后不涉及退订金额，将根据实际使用的资源量进行计费。

包年包月：终止任务即退订，退订包年包月的 DTS 任务后，退款金额将退还至账户余额。关于退款计算规则详情，请参见退订管理。包年包月仅适用于数据同步和数据订阅任务。

请求参数

参数	类型	是否必选	示例值	描述
TaskId	String	是	4ddec6d036384248a25862fb********	任务 ID。说明您可以调用 DescribeTransmissionTasks接口查询任务 ID。
StopAssociatedValidationTasks	Boolean	否	true	是否同时终止所选任务关联的数据校验任务，取值如下。 true：默认值，在终止此任务的同时，也将其所关联的所有数据校验任务一并终止。 false：仅终止此任务，不影响其所关联的数据校验任务。

返回参数

null

示例

请求示例

POST /?Action=StopTransmissionTask&Version=2022-10-01 HTTP/1.1​
Content-Type: application/json​
Host: dts.cn-beijing.volcengineapi.com​
X-Date: 20221001T101010Z​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20221001/cn-beijing/dts/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****​
{​
    "TaskId": "5cf6450e217b4c8eb834e339a5*****"​
}​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "20230320104141406D102417A9E80BEBDC",​
        "Action": "StopTransmissionTask",​
        "Version": "2022-10-01",​
        "Service": "dts",​
        "Region": "cn-beijing"​
    },​
    "Result": null​
}​

错误码

更多详情，请参见错误码。

最近更新时间：2026.02.03 14:23:46

这个页面对您有帮助吗？

有用

无用