任务管理API¶

所有URI均相对于{INTERACTIVE_ADMIN_ENDPOINT}

方法	HTTP请求	描述
CancelJob	DELETE /v1/job/{job_id}	取消指定jobId的任务
GetJobById	GET /v1/job/{job_id}	获取指定jobId的作业元数据
ListJobs	GET /v1/job	列出所有作业（包括历史作业）

取消任务¶

Result cancelJob(jobId)

请参阅bulkLoading了解如何提交批量加载作业。

示例¶

// Import classes:
import com.alibaba.graphscope.interactive.client.Driver;
import com.alibaba.graphscope.interactive.client.Session;
import com.alibaba.graphscope.interactive.client.common.Result;

public class Example {
  public static void main(String[] args) {
    Driver driver = Driver.connect();
    Session session = driver.session();

    String jobId = "2";  // See GraphManagementAPI#bulkLoading about how to submit a bulk loading job
    Result<String> getRes = session.cancelJob(jobId);
    if (!getRes.isOk()) {
        System.out.println("Failed to cancel job: " + getRes.getStatusMessage());
    } else {
        System.out.println("Canceled job: " + getRes.getValue());
    }
  }
}

参数¶

名称	类型	描述	备注
jobId	String

返回类型¶

结果<String>

授权¶

无需授权

HTTP请求头¶

Content-Type: 未定义
Accept: application/json

HTTP响应详情¶

状态码	描述	响应头
200	操作成功	-

GetJobById¶

Result getJobById(jobId)

示例¶

// Import classes:
import com.alibaba.graphscope.interactive.client.Driver;
import com.alibaba.graphscope.interactive.client.Session;
import com.alibaba.graphscope.interactive.client.common.Result;

public class Example {
  public static void main(String[] args) {
    Driver driver = Driver.connect();
    Session session = driver.session();

    String jobId = "2";  // See GraphManagementAPI#bulkLoading about how to submit a bulk loading job
    Result<JobStatus> getJobRes = session.getJobStatus(jobId);
    if (!getJobRes.isOk()) {
        System.out.println("Failed to get job status: " + getJobRes.getStatusMessage());
    } else {
        System.out.println("Got job status: " + getJobRes.getValue());
    }
  }
}

参数¶

名称	类型	描述	备注
jobId	String	作业ID，由POST /v1/graph/{graph_id}/dataloading接口返回

返回类型¶

结果<任务状态>

授权¶

无需授权

HTTP请求头¶

Content-Type: 未定义
Accept: application/json

HTTP响应详情¶

状态码	描述	响应头
200	操作成功	-

列出任务¶

List listJobs()

示例¶

// Import classes:
import com.alibaba.graphscope.interactive.client.Driver;
import com.alibaba.graphscope.interactive.client.Session;
import com.alibaba.graphscope.interactive.client.common.Result;

public class Example {
  public static void main(String[] args) {
    Driver driver = Driver.connect();
    Session session = driver.session();

    Result<List<JobStatus>> getJobsRes = session.listJobs();
    if (!getJobsRes.isOk()) {
        System.out.println("Failed to get jobs: " + getJobsRes.getStatusMessage());
    } else {
        System.out.println("Got jobs: " + getJobsRes.getValue());
    }
  }
}

参数¶

此端点不需要任何参数。

返回类型¶

结果<列表<任务状态>>

授权¶

无需授权

HTTP请求头¶

Content-Type: 未定义
Accept: application/json

HTTP响应详情¶

状态码	描述	响应头
200	操作成功	-