Cancel Download¶

Cancel a file download task.

Prerequisites¶

A file download task has been already created.

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

Name	Location (Path/Query)	Required/Optional	Data Type	Description
orgId	Query	Required	String	The OU ID which the application belongs to. How to get orgId >>
channelId	Path	Required	String	The channel ID which the file download task is using.
taskId	Path	Required	String	The file download task ID.

Name	Data Type	Description
taskId	String	The file download task ID.
progressCode	Integer	The status code of the file download task, fixed at `5`, indicating that it has been cancelled.
progressDesc	String	The status description of the file download task, fixed at `cancelled`, indicating that it has been 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"
  }
}