Get Download Status

获取文件下载任务的状态。

前提条件

已创建文件下载任务。

请求格式

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

请求参数(URI)

名称

位置(Path/Query)

必需/可选

数据类型

描述

orgId

Query

必需

String

用户所属的组织ID。如何获取orgId信息>>

channelId

Path

必需

String

通道ID。

taskId

Path

必需

String

文件下载任务ID。

响应参数

名称

数据类型

描述

data

List<JSONObject>

返回下载任务状态信息,详见 下载任务状态结构体

下载任务状态结构体

名称

数据类型

描述

taskId

String

文件下载任务ID。

downloadUrl

String

下载文件的URL。

progressCode

Integer

文件下载任务状态码(0:等待中;1:进行中;2:已失败;3:已完成;4:撤销中;5:已撤销;6:过期(删除)中;7:已过期)。

progressDesc

String

文件下载任务状态描述。

dataSize

Long

下载文档的数据大小,单位为 byte。

示例

请求示例

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

method: GET

返回示例

{
    "code": 0,
    "msg": "OK",
    "data": {
        "taskId": "79449f27d3ff44b3990c547360c2851f",
        "downloadUrl": "http://data-query-proxy.beta-k8s-cn4.eniot.io/channels/read/ch-dee0c5/download/79449f27d3ff44b3990c547360c2851f/data?orgId=o15504722874071",
        "progressDesc": "success",
        "progressCode": "3",
        "dataSize": "12345"
    }
}

SDK 示例


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