查询Job状态(1.0.0)-管理面
功能介绍
查询Job的执行状态。对创建图、关闭图、启动图、删除图、导入图等异步API命令下发后,会返回jobId,通过jobId查询任务的执行状态。
URI
- URI 格式
GET /v1.0/{projectId}/graphs/{graphId}/jobs/{jobId}/status
- 参数说明
表1 URI参数说明 参数
是否必选
类型
说明
projectId
是
String
项目编号,用于资源隔离。请参考获取项目ID。
graphId
是
String
图ID。
jobId
是
String
Job ID。
请求
- 请求样例
GET https://Endpoint/v1.0/{projectId}/graphs/{graphId}/jobs/{jobId}/status
响应
- 要素说明
表2 要素说明 参数
是否必选
类型
说明
errorMessage
否
String
系统提示信息,执行成功时,字段可能为空。执行失败时,用于显示错误信息。
errorCode
否
String
系统提示信息,执行成功时,字段可能为空。执行失败时,用于显示错误码。
Job属性列表
否
Json
参照表3 job属性列表。
表3 job属性列表 参数
是否必选
类型
说明
jobId
是
String
任务ID。
status
是
String
任务状态。
- pending:等待中
- running:运行中
- success:成功
- failed:失败
jobType
是
String
任务类型。
jobName
是
JsonArray
任务名称。
relatedGraph
是
String
关联图名称。
beginTime
否
String
任务开始时间,格式为UTC,"yyyy-MM-dd'T'HH:mm:ss"
endTime
否
String
任务结束时间,格式为UTC,"yyyy-MM-dd'T'HH:mm:ss"
jobDetail
否
JobDetail数据结构
只有jobName为ImportGraph时才返回,用于显示导入图详情。
failReason
否
String
任务失败原因
jobProgress
否
Double
任务执行进度,预留字段,暂未使用。
表4 JobDetail数据结构 参数
是否必选
类型
说明
schemaPath
是
JsonArray
元数据OBS路径。
edgesetPath
是
JsonArray
边数据集OBS路径。
vertexsetPath
否
JsonArray
点数据集OBS路径。
表5 edgesetPath和vertexsetPath属性列表 参数
是否必选
类型
说明
path
是
String
OBS文件路径。
log
否
String
导入OBS文件操作的日志存储文件。
status
是
String
导入OBS文件操作的状态。
- success:完全成功
- failed:完全失败
- partFailed:部分成功
cause
否
String
导入失败原因。
totalLines
否
Long
导入总行数。其值为-1时表示当前版本没有返回该字段。
failedLines
否
Long
导入失败行数。其值为-1时表示当前版本没有返回该字段。
successfulLines
否
Long
导出成功行数。其值为-1时表示当前版本没有返回该字段。
表6 schemaPath属性列表 参数
是否必选
类型
说明
path
是
String
OBS文件路径。
log
否
String
导入OBS文件操作的日志存储文件。
status
是
String
导入OBS文件操作的状态。
- success:完全成功
- failed:完全失败
- partFailed:部分成功
cause
否
String
导入失败原因。
- 请求成功样例
Http Status Code: 200 { "jobId": "ff80808167f09aaa0167f19b35ec0305", "status": "success", "jobType": "GraphManagement", "jobName": "ImportGraph", "relatedGraph": "GES_UI_AUTO", "beginTime": "2018-11-27T21:39:00", "endTime": "2018-11-27T21:39:56", "jobDetail": { "vertexsetPath": [ { "path": "ges-ui/auDatas/list_set_vertex.csv", "log": null, "cause": null, "status": "success" } ], "edgesetPath": [ { "path": "ges-ui/auDatas/list_set_edge.csv", "log": null, "cause": null, "status": "success" } ], "schemaPath": [ { "path": "ges-ui/auDatas/list_set_schema.xml", "log": null, "cause": null, "status": "success" } ] }, "jobProgress": 0 }
- 请求失败样例
Http Status Code: 400 { "errorMessage": "can not find job, jobId is ff808081646e81d40164c5fb414b2b1a1", "errorCode": "GES.8301" }
