更新时间:2023-11-09 GMT+08:00

查询job列表

功能介绍

异步任务jobId返回后,若jobId业务层丢失无法通过接口重新获取,现在提供一个新的接口用于查询engine中保存的所有异步任务,返回每个任务的jobId、job状态、原始请求。

图规格为持久化版的图,目前最多返回100000条请求。

URI

GET /ges/v1.0/{project_id}/graphs/{graph_name}/jobs/status?limit={limit}&offset={offset}
表1 路径参数

参数

是否必选

类型

说明

project_id

String

项目ID。获取方法请参见获取项目ID

job_id

String

Response对应的任务Job ID。

请求参数

详见路径参数。

响应参数

表2 响应Body参数说明

参数

类型

说明

errorMessage

String

系统提示信息。

  • 执行成功时,字段可能为空。
  • 执行失败时,用于显示错误信息。

errorCode

String

系统提示信息。

  • 执行成功时,字段可能为空。
  • 执行失败时,用于显示错误码。

result

String

查询成功时值为success,失败时值为failed。

jobs

Object

查询成功时包含jobs字段,jobs字段中包含系统中保存的job状态列表,单个job的状态结构如表3

表3 job状态结构

参数

类型

说明

jobId

String

Job名称。

request

Object

请求内容,包括command、url和body体。

status

String

Job执行状态,取值为pending/running/complete。

请求示例

查询job列表, 返回每个任务的jobId、job状态。

GET /ges/v1.0/{project_id}/graphs/movie/jobs/status

响应示例

状态码: 200

成功响应示例

Http Status Code: 200 
{
    "jobs": [
        {
            "jobId": "62582163123991943683d0f9aa3-f701-48be-a662-360e6a0455da",
            "status": "complete",
            "request": {
                "command": "import_graph",
                "url": "/ges/v1.0/10001/graphs/moviejx/action?action_id=import-graph",
                "body": {
                    "edgesetPath": "file:///root/ges-install/auDatas/ranking_edge-sp.csv",
                    "vertexsetPath": "file:///root/ges-install/auDatas/movies_vertex_new.csv",
                    "schemaPath": "file:///root/ges-install/auDatas/schema_aikv.xml.bak"
                }
            }
        },
        {
            "jobId": "62582163123991943683fe74caf-f4d3-48b3-b3ee-66daaedcd2ca",
            "status": "complete",
            "request": {
                "command": "import_graph",
                "url": "/ges/v1.0/10001/graphs/moviejx/action?action_id=import-graph",
                "body": {
                    "edgesetPath": "file:///root/ges-install/auDatas/ranking_edge-sp.csv",
                    "vertexsetPath": "file:///root/ges-install/auDatas/movies_vertex_new.csv",
                    "schemaPath": "file:///root/ges-install/auDatas/schema_aikv.xml.bak"
                }
            }
        },
        {
            "jobId": "6258216312399194368daa80df3-e3bd-440d-9764-74f4622a550f",
            "status": "complete",
            "request": {
                "command": "import_graph",
                "url": "/ges/v1.0/10001/graphs/moviejx/action?action_id=import-graph",
                "body": {
                    "edgesetPath": "file:///root/ges-install/auDatas/ranking_edge-sp.csv",
                    "vertexsetPath": "file:///root/ges-install/auDatas/movies_vertex_new.csv",
                    "schemaPath": "file:///root/ges-install/auDatas/schema_aikv.xml.bak"
                }
            }
        },
        {
            "jobId": "62582163123991943680ed2761f-01f7-4fbf-b867-0a9aae6d9c12",
            "status": "complete",
            "request": {
                "command": "import_graph",
                "url": "/ges/v1.0/10001/graphs/moviejx/action?action_id=import-graph",
                "body": {
                    "edgesetPath": "file:///root/ges-install/auDatas/ranking_edge-sp.csv",
                    "vertexsetPath": "file:///root/ges-install/auDatas/movies_vertex_new.csv",
                    "schemaPath": "file:///root/ges-install/auDatas/schema_aikv.xml.bak"
                }
            }
        }
    ],
    "result": "success"
}

状态码: 400

失败响应示例

Http Status Code: 400 
 { 
     "errorMessage": "graph : movidde not exist",
    "errorCode": "GES.8000",
    "result": "failed"
}

状态码

返回值

说明

400 Bad Request

请求错误。

401 Unauthorized

鉴权失败。

403 Forbidden

没有操作权限。

404 Not Found

找不到资源。

500 Internal Server Error

服务内部错误。

503 Service Unavailable

服务不可用。

错误码

请参见错误码