You need to enable JavaScript to run this app.
导航
StopTransmissionTasks
最近更新时间:2024.09.09 16:03:17首次发布时间:2023.09.06 19:17:38

调用 StopTransmissionTasks 接口批量终止传输任务。

请求类型

异步请求。

注意事项

  • 如果批量终止的任务中存在任务状态不是 RunningSuspend 的任务,则对应任务接口调用不成功。您可以调用 DescribeTransmissionTasks 接口查看传输任务的详细信息。

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

    • 按量付费:任务终止后不涉及退订金额,将根据实际使用的资源量进行计费。
    • 包年包月:终止任务即退订,退订包年包月的 DTS 任务后,退款金额将退还至账户余额。关于退款计算规则详情,请参见退订管理。包年包月仅适用于数据同步和数据订阅任务。

请求参数

参数
类型
是否必选
示例值
描述
TaskIds
String[]
["23208c23945048b482f4b0ece62****","f4f091ce030a4137b50fd60cdff****" ]

任务 ID。

说明

  • 您可以调用 DescribeTransmissionTasks 接口查询任务 ID。
  • 在进行批量终止任务时,多个任务 ID 间使用英文逗号(,)隔开。

返回参数

null

示例

请求示例

POST /?Action=StopTransmissionTasks&Version=2022-10-01 HTTP/1.1
Content-Type: application/json
Host: dts.volcengineapi.com
X-Date: 20221001T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20221001/cn-beijing/dts/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****
{
    "TaskIds": [
        "23208c23945048b482f4b0ece62****",
        "f4f091ce030a4137b50fd60cdff****"
    ]
}

返回示例

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

错误码

更多详情,请参见错误码