This is an automated email from the ASF dual-hosted git repository. jermy pushed a commit to branch website in repository https://gitbox.apache.org/repos/asf/incubator-hugegraph-doc.git
commit 65b14d6fda6dd83234a1494eab3781fbb6087390 Author: brain.duan <[email protected]> AuthorDate: Mon May 9 09:52:27 2022 +0800 issues-109 restapi -> rebuild and task API --- content/en/docs/clients/restful-api/rebuild.md | 19 +++++++++---------- content/en/docs/clients/restful-api/task.md | 17 ++++++++--------- 2 files changed, 17 insertions(+), 19 deletions(-) diff --git a/content/en/docs/clients/restful-api/rebuild.md b/content/en/docs/clients/restful-api/rebuild.md index eae5d17..9e2bcd8 100644 --- a/content/en/docs/clients/restful-api/rebuild.md +++ b/content/en/docs/clients/restful-api/rebuild.md @@ -6,7 +6,7 @@ weight: 6 ### 1.6 Rebuild -#### 1.6.1 重建IndexLabel +#### 1.6.1 Rebuild IndexLabel ##### Method & Url @@ -27,12 +27,11 @@ PUT http://localhost:8080/graphs/hugegraph/jobs/rebuild/indexlabels/personByCity "task_id": 1 } ``` +comment： -注： +> you can get the asynchronous job status by `GET http://localhost:8080/graphs/hugegraph/tasks/${task_id}` (the task_id here should be 1). See More [AsyncJob RESTfull API](../task) -> 可以通过`GET http://localhost:8080/graphs/hugegraph/tasks/1`（其中"1"是task_id）来查询异步任务的执行状态，更多[异步任务RESTful API](../task) - -#### 1.6.2 VertexLabel对应的全部索引重建 +#### 1.6.2 Rebulid all Indexs of VertexLabel ##### Method & Url @@ -54,11 +53,11 @@ PUT http://localhost:8080/graphs/hugegraph/jobs/rebuild/vertexlabels/person } ``` -注： +comment： -> 可以通过`GET http://localhost:8080/graphs/hugegraph/tasks/2`（其中"2"是task_id）来查询异步任务的执行状态，更多[异步任务RESTful API](../task) +> you can get the asynchronous job status by `GET http://localhost:8080/graphs/hugegraph/tasks/${task_id}` (the task_id here should be 2). See More [AsyncJob RESTfull API](../task) -#### 1.6.3 EdgeLabel对应的全部索引重建 +#### 1.6.3 Rebulid all Indexs of VertexLabel ##### Method & Url @@ -80,6 +79,6 @@ PUT http://localhost:8080/graphs/hugegraph/jobs/rebuild/edgelabels/created } ``` -注： +comment： -> 可以通过`GET http://localhost:8080/graphs/hugegraph/tasks/3`（其中"3"是task_id）来查询异步任务的执行状态，更多[异步任务RESTful API](../task) \ No newline at end of file +> you can get the asynchronous job status by `GET http://localhost:8080/graphs/hugegraph/tasks/${task_id}` (the task_id here should be 3). See More [AsyncJob RESTfull API](../task) \ No newline at end of file diff --git a/content/en/docs/clients/restful-api/task.md b/content/en/docs/clients/restful-api/task.md index f490501..86547a4 100644 --- a/content/en/docs/clients/restful-api/task.md +++ b/content/en/docs/clients/restful-api/task.md @@ -6,12 +6,12 @@ weight: 13 ### 7.1 Task -#### 7.1.1 列出某个图中全部的异步任务 +#### 7.1.1 list all asynTasks in graph ##### Params -- status: 异步任务的状态 -- limit：返回异步任务数目上限 +- status: the status of asynTasks +- limit：the max number of tasks to return ##### Method & Url @@ -45,7 +45,7 @@ GET http://localhost:8080/graphs/hugegraph/tasks?status=success } ``` -#### 7.1.2 查看某个异步任务的信息 +#### 7.1.2 view the details of an asyncTask ##### Method & Url @@ -77,7 +77,7 @@ GET http://localhost:8080/graphs/hugegraph/tasks/2 } ``` -#### 7.1.3 删除某个异步任务信息，**不删除异步任务本身** +#### 7.1.3 delete task infomation of an asyncTask，**won't delete the task itself** ##### Method & Url @@ -93,7 +93,7 @@ DELETE http://localhost:8080/graphs/hugegraph/tasks/2 #### 7.1.4 取消某个异步任务，**该异步任务必须具有处理中断的能力** -假设已经通过[Gremlin API](../gremlin)创建了一个异步任务如下： +if you already created an asyncTask via [Gremlin API](../gremlin) as follows： ```groovy "for (int i = 0; i < 10; i++) {" + @@ -112,8 +112,7 @@ DELETE http://localhost:8080/graphs/hugegraph/tasks/2 ``` PUT http://localhost:8080/graphs/hugegraph/tasks/2?action=cancel ``` - -> 请保证在10秒内发送该请求，如果超过10秒发送，任务可能已经执行完成，无法取消。 +> cancel it in 10s. if more than 10s，the task may already finished,then can't be cancelled. ##### Response Status @@ -129,4 +128,4 @@ PUT http://localhost:8080/graphs/hugegraph/tasks/2?action=cancel } ``` -此时查询 label 为 man 的顶点数目，一定是小于 10 的。 +query the number of vertex which label is man ，it must less than 10。
