• 文档
• List Jobs

List Jobs

查询与指定通道相关联的数据读取任务或写入任务。

前提条件

已创建通道，且通道已启动。

请求格式

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

请求参数（Header）

名称	必需/可选	数据类型	描述
Content-Type	必需	String	内容或文件类型，默认值为 application/json。

请求参数（URI）

名称	位置（Path/Query）	必需/可选	数据类型	描述
orgId	Query	必需	String	用户所属的组织ID。如何获取orgId信息>>
channelId	Path	必需	String	通道ID。

响应参数

名称	数据类型	描述
data	List<JSONObject>	返回任务列表，详见 任务结构体

任务结构体

名称	数据类型	描述
runningJobs	List<JSONObject>	运行中的任务列表，详见 任务信息结构体
finishedJobs	List<JSONObject>	已完成的任务列表，详见 任务信息结构体

任务信息结构体

名称	数据类型	描述
jobId	String	任务ID。
sqlQuery	String	数据查询SQL语句。
state	String	数据查询状态，状态值可为：Failed，Canceled，Succeeded。
requestTime	String	任务提交时间。
duration	String	任务运行时间。
startTime	String	任务开始时间。
endTime	String	任务结束时间。

示例

请求示例

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

method: GET

返回示例

{
   "msg": "OK",
   "code": 0,
   "data": {
   "runningJobs": null,
   "finishedJobs": [
       {
         "jobId": "2131ceb9-c00d-d42d-33db-c21002b97d16",
         "sqlQuery": "show schemas",
         "state": "Succeeded",
         "requestTime": "05/27/2020 09:22:13",
         "duration": "1.871 sec",
         "startTime": 1590571333699,
         "endTime": 1590571335570
       }]
    }
 }

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 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 listJobs() {
        Request request = new Request();
        request.setQueryParam("orgId", orgId);
        request.setMethod("GET");
        request.headerParams().put(HttpHeaders.CONTENT_TYPE, "application/json");
        try {
            JSONObject response = Poseidon.config(PConfig.init().appKey(accessKey).appSecret(secretKey))
                    .url(url + "/data-federation/v2.0/channels/read/" + chId + "/jobs")
                    .getResponse(request, JSONObject.class);
            System.out.println(response);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}