响应示例
4.5 任务中心 API
4.5.1 查询 Job 状态(1.0.0)-管理面
状态码
状态码 描述
200 OK
4.5 任务中心 API
4.5.1 查询 Job 状态(1.0.0)-管理面
功能介绍
查询Job的执行状态。对创建图、关闭图、启动图、删除图、导入图等异步API命令下 发后，会返回jobId，通过jobId查询任务的执行状态。
调试
您可以在API Explorer中调试该接口。
URI
GET /v1.0/{project_id}/graphs/{graph_id}/jobs/{job_id}/status
表4-131 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目编号，用于资源隔离。请参 考获取项目ID。
graph_id 是 String 图ID。
job_id 是 String Job ID。
请求参数
表4-132 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token。 通过调用IAM服务 获取用户Token接口获取（响应 消息头中X-Subject-Token的 值）。
响应参数
状态码： 200
表4-133 响应 Body 参数
参数 参数类型 描述
errorMessage String 系统提示信息，执行成功时，字段可能为空。执 行失败时，用于显示错误信息。
errorCode String 系统提示信息，执行成功时，字段可能为空。执 行失败时，用于显示错误码。
jobId String 任务ID。
status String 任务状态。
● pending:等待中
● running:运行中
● success:成功
● failed:失败 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 任务执行进度，预留字段，暂未使用。
表4-134 JobDetail
参数 参数类型 描述
schemaPath Array of schemaPath objects
元数据路径。
edgesetPath Array of edgesetPath objects
边数据集路径。
参数 参数类型 描述 vertexsetPath Array of
vertexsetPat h objects
点数据集路径。
表4-135 schemaPath
参数 参数类型 描述
path String OBS文件路径。
log String OBS文件导入日志存储文件。
status String OBS文件导入状态。
● success：完全成功
● failed：完全失败
● partFailed：部分成功 cause String 导入失败原因。
表4-136 edgesetPath
参数 参数类型 描述
path String OBS文件路径。
log String OBS文件导入日志存储文件。
status String OBS文件导入状态。
● success：完全成功
● failed：完全失败
● partFailed：部分成功 cause String 导入失败原因。
totalLines Long 导入总行数。其值为-1时表示当前版本没有返回 该字段。
failedLines Long 导入失败行数。其值为-1时表示当前版本没有返 回该字段。
successfulLine
s Long 导出成功行数。其值为-1时表示当前版本没有返
回该字段。
表4-137 vertexsetPath
参数 参数类型 描述
path String OBS文件路径。
log String OBS文件导入日志存储文件。
status String OBS文件导入状态。
● success：完全成功
● failed：完全失败
● partFailed：部分成功 cause String 导入失败原因。
totalLines Long 导入总行数。其值为-1时表示当前版本没有返回 该字段。
failedLines Long 导入失败行数。其值为-1时表示当前版本没有返 回该字段。
successfulLine
s 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,
"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 OK
400 Bad Request