Cancel Download

取消文件下载任务。

前提条件

已创建文件下载任务。

请求格式

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

请求参数(URI)

名称 位置(Path/Query) 必需/可选 数据类型 描述
orgId Query 必需 String 用户所属的组织ID。如何获取orgId信息>>
channelId Path 必需 String 通道ID。
taskId Path 必需 String 文件下载任务ID。

响应参数

名称 数据类型 描述
data List<JSONObject> 返回下载任务状态信息,详见 下载任务状态结构体

下载任务状态结构体

名称 数据类型 描述
taskId String 文件下载任务ID。
progressCode Integer 文件下载任务状态码(4:取消中)。
progressDesc String 文件下载任务状态描述。

示例

请求示例

url: https://{apigw-address}/data-federation/v2.0/channels/read/{channelId}/download/{taskId}?orgId={}

method: DELETE

返回示例

{
  "msg": "OK",
  "code": 0,
  "data": {
    "taskId": "40e1503fa6354acb8c6266400e8fe909",
    "progressCode": "4",
    "progressDesc": "cancelling"
  }
}

SDK 示例


你可以在 Github 上获取数据联邦的 SDK 示例: