Cancel Download¶
Cancel a file download task.
Prerequisites¶
A file download task is already created.
Request Format¶
DELETE https://{apigw-address}/data-federation/v2.0/channels/read/{channelId}/download/{taskId}
Request Parameters (URI)¶
Name | Location (Path/Query) | Mandatory/Optional | Data Type | Description |
---|---|---|---|---|
orgId | Query | Mandatory | String | The organization ID. How to get the orgId>> |
channelId | Path | Mandatory | String | Channel ID. |
taskId | Path | Mandatory | String | ID of the file download task. |
Response Parameters¶
Name | Data Type | Description |
---|---|---|
data | List<JSONObject> | Return the status information of the download task. See Status Struct |
Status¶
Name | Data Type | Description |
---|---|---|
taskId | String | ID of the file download task. |
progressCode | Integer | Status code of the file download task (4: cancelling). |
progressDesc | String | Description of the status code. |