Task API

7.1 Task

7.1.1 List all async tasks in graph

Params
  • status: the status of asyncTasks
  • limit: the max number of tasks to return
Method & Url
GET http://localhost:8080/graphs/hugegraph/tasks?status=success
Response Status
200
Response Body
{ "tasks": [{ "task_name": "hugegraph.traversal().V()", "task_progress": 0, "task_create": 1532943976585, "task_status": "success", "task_update": 1532943976736, "task_result": "0", "task_retries": 0, "id": 2, "task_type": "gremlin", "task_callable": "org.apache.hugegraph.api.job.GremlinAPI$GremlinJob", "task_input": "{\"gremlin\":\"hugegraph.traversal().V()\",\"bindings\":{},\"language\":\"gremlin-groovy\",\"aliases\":{\"hugegraph\":\"graph\"}}" }] }

7.1.2 View the details of an async task

Method & Url
GET http://localhost:8080/graphs/hugegraph/tasks/2
Response Status
200
Response Body
{ "task_name": "hugegraph.traversal().V()", "task_progress": 0, "task_create": 1532943976585, "task_status": "success", "task_update": 1532943976736, "task_result": "0", "task_retries": 0, "id": 2, "task_type": "gremlin", "task_callable": "org.apache.hugegraph.api.job.GremlinAPI$GremlinJob", "task_input": "{\"gremlin\":\"hugegraph.traversal().V()\",\"bindings\":{},\"language\":\"gremlin-groovy\",\"aliases\":{\"hugegraph\":\"graph\"}}" }

7.1.3 Delete task information of an async task,won’t delete the task itself

Method & Url
DELETE http://localhost:8080/graphs/hugegraph/tasks/2
Response Status
204

7.1.4 Cancel an async task, the task should be able to be canceled

If you already created an async task via Gremlin API as follows:

"for (int i = 0; i < 10; i++) {" +  "hugegraph.addVertex(T.label, 'man');" +  "hugegraph.tx().commit();" +  "try {" +  "sleep(1000);" +  "} catch (InterruptedException e) {" +  "break;" +  "}" + "}"
Method & Url
PUT http://localhost:8080/graphs/hugegraph/tasks/2?action=cancel

cancel it in 10s. if more than 10s, the task may already be finished, then can’t be cancelled.

Response Status
202
Response Body
{  "cancelled": true }

At this point, the number of vertices whose label is man must be less than 10.

Last modified June 13, 2025: BREAKING CHANGE: refactor doc structure & add new content for client/AI (#407) (48ff6f26)