查询Job状态(1.0.0)-管理面
功能介绍
查询Job的执行状态。对创建图、关闭图、启动图、删除图、导入图等异步API命令下发后，会返回jobId，通过jobId查询任务的执行状态。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1.0/{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
参数 |
参数类型 |
描述 |
|---|---|---|
errorMessage |
String |
系统提示信息。
|
errorCode |
String |
系统提示信息。
|
jobId |
String |
任务ID。 |
status |
String |
任务状态。
|
jobType |
String |
任务类型。 |
jobName |
String |
任务名称。 |
relatedGraph |
String |
关联图名称。 |
beginTime |
String |
任务开始时间，格式为UTC,"yyyy-MM-dd'T'HH:mm:ss" |
endTime |
String |
任务结束时间，格式为UTC,"yyyy-MM-dd'T'HH:mm:ss" |
jobDetail |
JobDetail object |
只有jobName为ImportGraph时才返回，用于显示导入图详情。 |
failReason |
String |
任务失败原因。 |
jobProgress |
Double |
任务执行进度，预留字段，暂未使用。 |
参数 |
参数类型 |
描述 |
|---|---|---|
schemaPath |
Array of schemaPath objects |
元数据路径。 |
edgesetPath |
Array of edgesetPath objects |
边数据集路径。 |
vertexsetPath |
Array of vertexsetPath objects |
点数据集路径。 |
参数 |
参数类型 |
描述 |
|---|---|---|
path |
String |
OBS文件路径。 |
log |
String |
OBS文件导入日志存储文件。 |
status |
String |
OBS文件导入状态。
|
cause |
String |
导入失败原因。 |
参数 |
参数类型 |
描述 |
|---|---|---|
path |
String |
OBS文件路径。 |
log |
String |
OBS文件导入日志存储文件。 |
status |
String |
OBS文件导入状态。
|
cause |
String |
导入失败原因。 |
totalLines |
Long |
导入的总行数，以您的配额以及所创图的规格为准。其值为-1时表示当前版本没有返回该字段。 |
failedLines |
Long |
导入失败行数。其值为-1时表示当前版本没有返回该字段。 |
successfulLines |
Long |
导出成功行数。其值为-1时表示当前版本没有返回该字段。 |
参数 |
参数类型 |
描述 |
|---|---|---|
path |
String |
OBS文件路径。 |
log |
String |
OBS文件导入日志存储文件。 |
status |
String |
OBS文件导入状态。
|
cause |
String |
导入失败原因。 |
totalLines |
Long |
导入总行数。以您的配额以及所创图的规格为准，其值为-1时表示当前版本没有返回该字段。 |
failedLines |
Long |
导入失败行数。其值为-1时表示当前版本没有返回该字段。 |
successfulLines |
Long |
导出成功行数。其值为-1时表示当前版本没有返回该字段。 |
请求示例
GET https://Endpoint/v1.0/{project_id}/graphs/{graph_id}/jobs/{job_id}/status
响应示例
状态码： 200
OK
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
}
状态码： 400
Bad Request
{
"errorMessage" : "can not find job, jobId is ff808081646e81d40164c5fb414b2b1a1",
"errorCode" : "GES.8301"
}
状态码
状态码 |
说明 |
|---|---|
200 |
请求成功。 |
400 |
请求错误。 |
401 |
鉴权失败。 |
403 |
没有操作权限。 |
404 |
找不到资源。 |
500 |
服务内部错误。 |
503 |
服务不可用。 |
