gs_interactive.AdminServiceJobManagementApi

所有URI均相对于{INTERACTIVE_ADMIN_ENDPOINT}

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

取消任务

结果[str] cancel_job(job_id)

示例

from gs_interactive.client.driver import Driver
from gs_interactive.client.session import Session
from gs_interactive.models import *

driver = Driver()
sess = driver.session()

# loading_resp = sess.bulk_loading(graph_id, bulk_load_request)
# job_id = resp.get_value().job_id
resp = sess.cancel_job(job_id)
assert resp.is_ok()
print("cancel job resp", resp)

参数

名称	类型	描述	备注
job_id	str

返回类型

结果[str]

授权

无需授权

HTTP请求头

• Content-Type: 未定义

• Accept: application/json

HTTP响应详情

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

[返回顶部] [返回API列表] [返回模型列表] [返回python_sdk]

GetJobById

Result[JobStatus] get_job(job_id)

示例

resp = sess.get_job(job_id)
assert resp.is_ok()
status = resp.get_value().status
print("job status: ", status)

参数

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

返回类型

结果[任务状态]

授权

无需授权

HTTP请求头

• Content-Type: 未定义

• Accept: application/json

HTTP响应详情

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

[返回顶部] [返回API列表] [返回模型列表] [返回python_sdk]

列出任务

结果[List[JobStatus]] list_jobs()

示例

resp = sess.list_jobs(job_id)
assert resp.is_ok()
print("list job resp: ", resp)

参数

此端点不需要任何参数。

返回类型

结果[List[JobStatus]]

授权

无需授权

HTTP请求头

• Content-Type: 未定义

• Accept: application/json

HTTP响应详情

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

[返回顶部] [返回API列表] [返回模型列表] [返回python_sdk]