Cancel Download


撤销文件下载任务。

前提条件


已创建文件下载任务。

请求格式


DELETE https://{apigw-address}/data-federation/v2.0/channels/read/{channelId}/download/{taskId}

请求参数(URI)


名称

位置(Path/Query)

必需/可选

数据类型

描述

orgId

Query

必需

String

应用所属的 OU ID。如何获取 orgId 信息 >>

channelId

Path

必需

String

文件下载任务使用的通道 ID。

taskId

Path

必需

String

文件下载任务 ID。

响应参数


名称

数据类型

描述

taskId

String

文件下载任务 ID。

progressCode

Integer

文件下载任务状态码,固定为 5,表示已撤销。

progressDesc

String

文件下载任务状态描述,固定为 cancelled,表示已撤销。

示例

请求示例


url: https://{apigw-address}/data-federation/v2.0/channels/read/yourchannelId/download/yourtaskId?orgId=yourorgId
method: DELETE

返回示例


{
  "msg": "OK",
  "code": 0,
  "data": {
    "taskId": "yourtaskId",
    "progressCode": "5",
    "progressDesc": "cancelled"
  }
}