查询任务中心(1.1.8)
功能介绍
查询管理面任务中心。当前创建图、关闭图、启动图、删除图、增加备份、导入图、导出图、升级图等操作为异步任务,该API用于查询这些任务的详情。
URI
GET /v2/{project_id}/graphs/jobs
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目编号,用于资源隔离。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
end_time |
否 |
String |
任务结束日期,当前只支持日期,不支持时间。格式为:yyyy-MM-dd,比如2019-03-27。 |
graph_name |
否 |
String |
关联的图名称。 |
limit |
否 |
String |
每页资源数量的最大值,默认为10。 |
offset |
否 |
String |
本次请求的起始位置,默认为0。 |
start_time |
否 |
String |
任务开始日期,当前只支持日期,不支持时间。格式为:yyyy-MM-dd,比如2019-03-27。 |
status |
否 |
String |
任务状态。取值为:
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 用于获取操作API的权限。获取方法请参见获取Token接口,响应消息头中X-Subject-Token的值即为Token。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
job_count |
Integer |
任务总数。 |
job_list |
Array of job_list objects |
任务列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
只有jobName为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 |
系统提示信息。
|
请求示例
查询管理面任务中心。
GET https://Endpoint/v2/{project_id}/graphs/jobs?offset=0&limit=100
响应示例
状态码: 200
成功响应示例
{ "job_count" : 2, "job_list" : [ { "job_id" : "ff80808167bb90340167bc3c7b5b026a", "status" : "success", "job_type" : "GraphManagement", "job_name" : "ImportGraph", "related_graph" : "test1217", "begin_time" : "2018-12-17T12:55:40", "end_time" : "2018-12-17T12:56:32", "job_detail" : { "vertexset_path" : null, "edgeset_path" : [ { "path" : "hkmovie/edge.csv", "log" : null, "cause" : null, "status" : "success" } ], "schema_path" : [ { "path" : "hkmovie/schema.xml", "log" : null, "cause" : null, "status" : "success" } ] }, "job_progress" : 0 }, { "job_id" : "ff80808167bb90340167bc5d0b1d0358", "status" : "success", "job_type" : "GraphManagement", "job_name" : "DeleteGraph", "related_graph" : "test1218", "begin_time" : "2018-12-17T13:31:14", "end_time" : "2018-12-17T13:34:48", "job_progress" : 0 } ] }
状态码: 400
失败响应示例
{ "error_msg" : "failed", "error_code" : "GES.9999" }
状态码
返回值 |
说明 |
---|---|
400 Bad Request |
请求错误 |
401 Unauthorized |
鉴权失败 |
403 Forbidden |
没有操作权限 |
404 Not Found |
找不到资源 |
500 Internal Server Error |
服务内部错误 |
503 Service Unavailable |
服务不可用 |
错误码
请参见错误码。