Get Download Status¶
获取文件下载任务的状态。
前提条件¶
已创建文件下载任务。
请求格式¶
GET https://{apigw-address}/data-federation/v2.0/channels/read/{channelId}/download/{taskId}/status
请求参数(URI)¶
名称 |
位置(Path/Query) |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|---|
orgId |
Query |
必需 |
String |
应用所属的 OU ID。如何获取 orgId 信息 >> |
channelId |
Path |
必需 |
String |
文件下载任务使用的通道 ID。 |
taskId |
Path |
必需 |
String |
文件下载任务 ID。 |
响应参数¶
名称 |
数据类型 |
描述 |
---|---|---|
taskId |
String |
文件下载任务 ID。 |
downloadUrl |
String |
下载文件的 URL。 |
progressDesc |
String |
文件下载任务状态描述:
|
progressCode |
Integer |
文件下载任务状态码:
|
dataSize |
Long |
所下载文件的数据大小,单位为 byte。 |
示例¶
请求示例¶
url: https://{apigw-address}/data-federation/v2.0/channels/read/yourchannelId/download/yourtaskId/status?orgId=yourOrgId
method: GET
返回示例¶
{
"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"
}
}