Get Download Status¶

Get the status of a file download task.

Prerequisites¶

A file download task has been already created.

Request Format¶

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

Request Parameters (URI)¶

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	ID of the file download task.

Response Parameters¶

Name	Data Type	Description
taskId	String	ID of the file download task.
downloadUrl	String	URL for downloading the file.
progressDesc	String	The status of the task: `waiting` `downloading` `fail` `success` `cancelled`
progressCode	Integer	The status code of the task: `0`: Waiting `1`: Downloading `2`: Failed `3`: Successful `5`: Cancelled
dataSize	Long	The data size of the downloaded file, in bytes.

Samples¶

Request Sample¶

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

Return Sample¶

{
    "code": 0,
    "msg": "OK",
    "data": {
        "taskId": "yourtaskId",
        "downloadUrl": "http://data-query-proxy.beta-k8s-cn5.envisioniot.com/channels/read/ch-dee0c5/download/yourtaskId/data?orgId=yourOrgId",
        "progressDesc": "success",
        "progressCode": "3",
        "dataSize": "2200"
    }
}