查询Job状态(1.0.0)-管理面
功能介绍
查询Job的执行状态。对创建图、关闭图、启动图、删除图、导入图等异步API命令下发后，会返回jobId，通过jobId查询任务的执行状态。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/graphs/{graph_id}/jobs/{job_id}/status
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。获取方法请参见获取项目ID。 |
|
graph_id |
是 |
String |
图ID。 |
|
job_id |
是 |
String |
执行异步任务的JobID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 用于获取操作API的权限。获取方法请参见获取Token接口，响应消息头中X-Subject-Token的值即为Token。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
job_id |
String |
任务ID。 |
|
status |
String |
任务状态。
|
|
job_type |
String |
任务类型。 |
|
job_name |
String |
任务名称。 |
|
related_graph |
String |
关联图名称。 |
|
begin_time |
String |
任务开始时间，格式为UTC,"yyyy-MM-dd'T'HH:mm:ss" |
|
end_time |
String |
任务结束时间，格式为UTC,"yyyy-MM-dd'T'HH:mm:ss" |
|
job_detail |
job_detail object |
只有job_name为ImportGraph时才返回，用于显示导入图详情。 |
|
fail_reason |
String |
任务失败原因 |
|
job_progress |
Double |
任务执行进度，预留字段，暂未使用。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
schema_path |
Array of schema_path objects |
元数据路径。 |
|
edgeset_path |
Array of edgeset_path objects |
边数据集路径。 |
|
vertexset_path |
Array of vertexset_path objects |
点数据集路径。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
path |
String |
OBS文件路径。 |
|
log |
String |
OBS文件导入的日志存储文件。 |
|
status |
String |
OBS文件导入状态。
|
|
cause |
String |
导入失败原因。 |
|
total_lines |
Long |
导入总行数。其值为-1时表示当前版本没有返回该字段。 |
|
failed_lines |
Long |
导入失败行数。其值为-1时表示当前版本没有返回该字段。 |
|
successful_lines |
Long |
导入成功行数。其值为-1时表示当前版本没有返回该字段。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
path |
String |
OBS文件路径。 |
|
log |
String |
OBS文件导入的日志存储文件。 |
|
status |
String |
OBS文件导入状态。
|
|
cause |
String |
导入失败原因。 |
|
total_lines |
Long |
导入总行数。其值为-1时表示当前版本没有返回该字段。 |
|
failed_lines |
Long |
导入失败行数。其值为-1时表示当前版本没有返回该字段。 |
|
successful_lines |
Long |
导入成功行数。其值为-1时表示当前版本没有返回该字段。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
path |
String |
OBS文件路径。 |
|
log |
String |
OBS文件导入的日志存储文件。 |
|
status |
String |
OBS文件导入状态。
|
|
cause |
String |
导入失败原因。 |
|
total_lines |
Long |
导入总行数。其值为-1时表示当前版本没有返回该字段。 |
|
failed_lines |
Long |
导入失败行数。其值为-1时表示当前版本没有返回该字段。 |
|
successful_lines |
Long |
导入成功行数。其值为-1时表示当前版本没有返回该字段。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
系统提示信息。
|
|
error_msg |
String |
系统提示信息。
|
请求示例
查询Job的执行状态。
GET https://{Endpoint}/v2/{project_id}/graphs/{graph_id}/jobs/{job_id}/status
响应示例
状态码： 200
成功响应示例
{
"job_id" : "ff80808167f09aaa0167f19b35ec0305",
"status" : "success",
"job_type" : "GraphManagement",
"job_name" : "ImportGraph",
"related_graph" : "GES_UI_AUTO",
"begin_time" : "2018-11-27T21:39:00",
"end_time" : "2018-11-27T21:39:56",
"job_detail" : {
"vertexset_path" : [ {
"path" : "ges-ui/auDatas/list_set_vertex.csv",
"log" : null,
"cause" : null,
"status" : "success"
} ],
"edgeset_path" : [ {
"path" : "ges-ui/auDatas/list_set_edge.csv",
"log" : null,
"cause" : null,
"status" : "success"
} ],
"schema_path" : [ {
"path" : "ges-ui/auDatas/list_set_schema.xml",
"log" : null,
"cause" : null,
"status" : "success"
} ]
},
"job_progress" : 0
}
状态码： 400
失败响应示例
{
"error_msg" : "can not find job, jobId is ff808081646e81d40164c5fb414b2b1a1",
"error_code" : "GES.8301"
}
状态码
|
返回值 |
说明 |
|---|---|
|
400 Bad Request |
请求错误 |
|
401 Unauthorized |
鉴权失败 |
|
403 Forbidden |
没有操作权限 |
|
404 Not Found |
找不到资源 |
|
500 Internal Server Error |
服务内部错误 |
|
503 Service Unavailable |
服务不可用 |
错误码
请参见错误码。
