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"
    }
}

Java SDK调用示例¶

import com.alibaba.fastjson.JSONObject;
import com.envision.apim.poseidon.config.PConfig;
import com.envision.apim.poseidon.core.Poseidon;
import com.envision.apim.poseidon.request.PoseidonRequest;
import com.google.common.net.HttpHeaders;
import org.apache.commons.codec.binary.Hex;
import org.junit.Test;

import java.nio.charset.StandardCharsets;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;

public class Sample {

    private static String accessKey = "AccessKey of your APP";
    private static String secretKey = "SecretKey of your APP";
    private static String orgId = "yourOrgId";
    private static String chId = "yourChannelId";
    private static String taskId = "yourTaskId";
    private static String url = "https://{domain_url}";

    private static class Request extends PoseidonRequest {

        public void setQueryParam(String key, Object value) {
            queryEncodeParams().put(key, value);
        }

        public void setMethod(String method) {
            this.method = method;
        }

        public void setBodyParams(String key, Object value) {
            bodyParams().put(key, value);
        }

        private String method;

        @Override
        public String baseUri() {
            return "";
        }

        @Override
        public String method() {
            return method;
        }
    }

    @Test
    public void downloadStatus() {
        Request request = new Request();
        request.setQueryParam("orgId", orgId);
        request.setMethod("GET");
        try {
            JSONObject response = Poseidon.config(PConfig.init().appKey(accessKey).appSecret(secretKey))
                    .url(url + "/data-federation/v2.0/channels/read/" + chId + "/download/" + taskId + "/status")
                    .getResponse(request, JSONObject.class);
            System.out.println(response);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}