Querying the Job List

Function

Query all asynchronous jobs saved in the engine and return the ID, status, and original request of each job.

A maximum of 100 thousand records can be returned for database edition graphs.

URI

GET /ges/v1.0/{project_id}/graphs/{graph_name}/jobs/status?limit={limit}&offset={offset}

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
graph_name	Yes	String	Graph name
limit	No	Integer	Maximum number of records that can be queried. The default value is 100000.
offset	No	Integer	Offset of a query. The default value is 0.

Request Parameters

None

Response Parameters

**Table 2** Response body parameter descriptions
Parameter	Type	Description
errorMessage	String	System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error message.
errorCode	String	System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.
result	String	Query result. The value is success for a successful query and failed for a failed query.
jobs	Object	Job status list stored in the system. If execution succeeds, this parameter is contained in the response. Table 3 describes the structure of a single jobs field.
totalCount	Integer	Total number of tasks to be queried

**Table 3** Job status structure
Parameter	Type	Description
job_id	String	Job name.
request	Object	Request content, including the command, URL, and body.
status	String	Job status. The value can be pending, running, complete, success, or failed.

Example Request

Query the job list and return the job ID and status of each job.

GET http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/jobs/status

Example Response

Status code: 200

Example response for a successful request

Http Status Code: 200 
{
    "jobs": [
        {
            "jobId": "4ae64af4226f9b91a469c7e609e00b800000382489090",
            "status": "success",
            "request": {
                "command": "batch_build_index",
                "url": "/ges/v1.0/854d9316e71d4dc599c5f27ea323d445/graphs/ges_j60071198_hdfs_fdb/indices/action?action_id=batch-build&targetGraphName=ges_j60071198_hdfs_fdb",
                "rawRequest": "{\"indices\":[{\"indexType\":\"GlobalCompositeEdgeIndex\",\"indexName\":\"cypher_edge_index\",\"indexProperty\":[],\"hasLabel\":true},{\"indexType\":\"GlobalCompositeVertexIndex\",\"indexName\":\"cypher_vertex_index\",\"indexProperty\":[],\"hasLabel\":true}]}"
            }
        },
        {
            "jobId": "d33bdeef9923fc24e20a38b11dbb13540000382489090",
            "status": "success",
            "request": {
                "command": "import_graph",
                "url": "/ges/v1.0/854d9316e71d4dc599c5f27ea323d445/graphs/ges_j60071198_hdfs_fdb/action?action_id=import-graph",
                "rawRequest": "{\"graphName\":\"ges_j60071198_hdfs_fdb\",\"offline\":false,\"edgesetPath\":\"/user/GES/audata/ranking_edge.csv\",\"vertexsetPath\":\"/user/GES/audata/movies_vertex_new.csv\",\"delimiter\":\",\",\"trimQuote\":\"\\\"\",\"vertexsetFormat\":\"csv\",\"parallelEdge\":{\"ignoreLabel\":false,\"action\":\"override\"},\"edgesetFormat\":\"csv\"}"
            }
        },
        {
            "jobId": "3d29c4aac80382aa161214ca716bbf860000382489090",
            "status": "success",
            "request": {
                "command": "import_graph",
                "url": "/ges/v1.0/854d9316e71d4dc599c5f27ea323d445/graphs/ges_j60071198_hdfs_fdb/action?action_id=import-graph",
                "rawRequest": "{\"graphName\":\"ges_j60071198_hdfs_fdb\",\"offline\":false,\"edgesetPath\":\"\",\"vertexsetPath\":\"\",\"delimiter\":\",\",\"schemaPath\":\"/user/GES/audata/schema_aikv.xml\",\"trimQuote\":\"\\\"\",\"vertexsetFormat\":\"csv\",\"parallelEdge\":{\"ignoreLabel\":false,\"action\":\"override\"},\"edgesetFormat\":\"csv\"}"
            }
        }
    ],
    "totalCount": 3,
    "result": "success"
}

Status code: 400

Example response for a failed request

Http Status Code: 400 
{
    "errorMessage": "Parameter error!",
    "errorCode": "GES.8005"
}

Status Codes

Return Value	Description
400 Bad Request	Request error.
401 Unauthorized	Authorization failed.
403 Forbidden	No operation permissions.
404 Not Found	No resources found.
500 Internal Server Error	Internal server error.
503 Service Unavailable	Service unavailable.