From 54182b7e6d904b037f88d2567c5dcc694390ff8d Mon Sep 17 00:00:00 2001 From: JisoLya <523420504@qq.com> Date: Mon, 4 Aug 2025 14:27:36 +0800 Subject: [PATCH 1/4] doc:fix the url of node status checking --- .../cn/docs/quickstart/hugegraph/hugegraph-hstore.md | 7 ++++++- content/en/docs/quickstart/hugegraph/hugegraph-pd.md | 12 ++++++++++++ 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/content/cn/docs/quickstart/hugegraph/hugegraph-hstore.md b/content/cn/docs/quickstart/hugegraph/hugegraph-hstore.md index fd5eb65fd..38b4d0d10 100644 --- a/content/cn/docs/quickstart/hugegraph/hugegraph-hstore.md +++ b/content/cn/docs/quickstart/hugegraph/hugegraph-hstore.md @@ -201,5 +201,10 @@ curl http://localhost:8520/actuator/health 此外,可以通过 PD 的 API 查看集群中的 Store 节点状态: ```bash -curl http://localhost:8620/pd/api/v1/stores +curl http://localhost:8620/v1/stores ``` + +如果Store配置成功,上述接口的响应中应该包含当前节点的状态信息,状态为Up表示节点正常运行,这里只展示了一个节点配置成功的响应,如果三个节点都配置成功并正在运行,响应中`storeId`列表应该包含三个id,并且`stateCountMap`中`Up`、`numOfService`、`numOfNormalService`三个字段应该为3。 +```JSON +{"message":"OK","data":{"stores":[{"storeId":8319292642220586694,"address":"127.0.0.1:8500","raftAddress":"127.0.0.1:8510","version":"","state":"Up","deployPath":"/Users/{your_user_name}/hugegraph/apache-hugegraph-incubating-1.5.0/apache-hugegraph-store-incubating-1.5.0/lib/hg-store-node-1.5.0.jar","dataPath":"./storage","startTimeStamp":1754027127969,"registedTimeStamp":1754027127969,"lastHeartBeat":1754027909444,"capacity":494384795648,"available":346535829504,"partitionCount":0,"graphSize":0,"keyCount":0,"leaderCount":0,"serviceName":"127.0.0.1:8500-store","serviceVersion":"","serviceCreatedTimeStamp":1754027127000,"partitions":[]}],"stateCountMap":{"Up":1},"numOfService":1,"numOfNormalService":1},"status":0} +``` \ No newline at end of file diff --git a/content/en/docs/quickstart/hugegraph/hugegraph-pd.md b/content/en/docs/quickstart/hugegraph/hugegraph-pd.md index 8b9b4893c..eb179f72c 100644 --- a/content/en/docs/quickstart/hugegraph/hugegraph-pd.md +++ b/content/en/docs/quickstart/hugegraph/hugegraph-pd.md @@ -136,3 +136,15 @@ curl http://localhost:8620/actuator/health ``` If it returns `{"status":"UP"}`, it indicates that the PD service has been successfully started. + +Additionally, you can verify the status of the Store node by querying the PD API: + +```bash +curl http://localhost:8620/v1/stores +``` + +If the Store is configured successfully, the response of the above interface should contain the status information of the current node. The status "Up" indicates that the node is running normally. Only the response of one node configuration is shown here. If all three nodes are configured successfully and are running, the `storeId` list in the response should contain three IDs, and the `Up`, `numOfService`, and `numOfNormalService` fields in `stateCountMap` should be 3. + +```JSON +{"message":"OK","data":{"stores":[{"storeId":8319292642220586694,"address":"127.0.0.1:8500","raftAddress":"127.0.0.1:8510","version":"","state":"Up","deployPath":"/Users/{your_user_name}/hugegraph/apache-hugegraph-incubating-1.5.0/apache-hugegraph-store-incubating-1.5.0/lib/hg-store-node-1.5.0.jar","dataPath":"./storage","startTimeStamp":1754027127969,"registedTimeStamp":1754027127969,"lastHeartBeat":1754027909444,"capacity":494384795648,"available":346535829504,"partitionCount":0,"graphSize":0,"keyCount":0,"leaderCount":0,"serviceName":"127.0.0.1:8500-store","serviceVersion":"","serviceCreatedTimeStamp":1754027127000,"partitions":[]}],"stateCountMap":{"Up":1},"numOfService":1,"numOfNormalService":1},"status":0} +``` From 397bb467f00bdf6a94c416d8b2fe1f682c272976 Mon Sep 17 00:00:00 2001 From: JisoLya <523420504@qq.com> Date: Mon, 4 Aug 2025 17:03:41 +0800 Subject: [PATCH 2/4] doc: reformat json string --- .../quickstart/hugegraph/hugegraph-hstore.md | 36 ++++++++++++++++++- .../docs/quickstart/hugegraph/hugegraph-pd.md | 36 ++++++++++++++++++- 2 files changed, 70 insertions(+), 2 deletions(-) diff --git a/content/cn/docs/quickstart/hugegraph/hugegraph-hstore.md b/content/cn/docs/quickstart/hugegraph/hugegraph-hstore.md index 38b4d0d10..9f7f1173d 100644 --- a/content/cn/docs/quickstart/hugegraph/hugegraph-hstore.md +++ b/content/cn/docs/quickstart/hugegraph/hugegraph-hstore.md @@ -206,5 +206,39 @@ curl http://localhost:8620/v1/stores 如果Store配置成功,上述接口的响应中应该包含当前节点的状态信息,状态为Up表示节点正常运行,这里只展示了一个节点配置成功的响应,如果三个节点都配置成功并正在运行,响应中`storeId`列表应该包含三个id,并且`stateCountMap`中`Up`、`numOfService`、`numOfNormalService`三个字段应该为3。 ```JSON -{"message":"OK","data":{"stores":[{"storeId":8319292642220586694,"address":"127.0.0.1:8500","raftAddress":"127.0.0.1:8510","version":"","state":"Up","deployPath":"/Users/{your_user_name}/hugegraph/apache-hugegraph-incubating-1.5.0/apache-hugegraph-store-incubating-1.5.0/lib/hg-store-node-1.5.0.jar","dataPath":"./storage","startTimeStamp":1754027127969,"registedTimeStamp":1754027127969,"lastHeartBeat":1754027909444,"capacity":494384795648,"available":346535829504,"partitionCount":0,"graphSize":0,"keyCount":0,"leaderCount":0,"serviceName":"127.0.0.1:8500-store","serviceVersion":"","serviceCreatedTimeStamp":1754027127000,"partitions":[]}],"stateCountMap":{"Up":1},"numOfService":1,"numOfNormalService":1},"status":0} +{ + "message": "OK", + "data": { + "stores": [ + { + "storeId": 8319292642220586694, + "address": "127.0.0.1:8500", + "raftAddress": "127.0.0.1:8510", + "version": "", + "state": "Up", + "deployPath": "/Users/{your_user_name}/hugegraph/ apache-hugegraph-incubating-1.5.0/apache-hugegraph-store-incubating-1.5.0/lib/hg-store-node-1.5.0.jar", + "dataPath": "./storage", + "startTimeStamp": 1754027127969, + "registedTimeStamp": 1754027127969, + "lastHeartBeat": 1754027909444, + "capacity": 494384795648, + "available": 346535829504, + "partitionCount": 0, + "graphSize": 0, + "keyCount": 0, + "leaderCount": 0, + "serviceName": "127.0.0.1:8500-store", + "serviceVersion": "", + "serviceCreatedTimeStamp": 1754027127000, + "partitions": [] + } + ], + "stateCountMap": { + "Up": 1 + }, + "numOfService": 1, + "numOfNormalService": 1 + }, + "status": 0 +} ``` \ No newline at end of file diff --git a/content/en/docs/quickstart/hugegraph/hugegraph-pd.md b/content/en/docs/quickstart/hugegraph/hugegraph-pd.md index eb179f72c..5880ae169 100644 --- a/content/en/docs/quickstart/hugegraph/hugegraph-pd.md +++ b/content/en/docs/quickstart/hugegraph/hugegraph-pd.md @@ -146,5 +146,39 @@ curl http://localhost:8620/v1/stores If the Store is configured successfully, the response of the above interface should contain the status information of the current node. The status "Up" indicates that the node is running normally. Only the response of one node configuration is shown here. If all three nodes are configured successfully and are running, the `storeId` list in the response should contain three IDs, and the `Up`, `numOfService`, and `numOfNormalService` fields in `stateCountMap` should be 3. ```JSON -{"message":"OK","data":{"stores":[{"storeId":8319292642220586694,"address":"127.0.0.1:8500","raftAddress":"127.0.0.1:8510","version":"","state":"Up","deployPath":"/Users/{your_user_name}/hugegraph/apache-hugegraph-incubating-1.5.0/apache-hugegraph-store-incubating-1.5.0/lib/hg-store-node-1.5.0.jar","dataPath":"./storage","startTimeStamp":1754027127969,"registedTimeStamp":1754027127969,"lastHeartBeat":1754027909444,"capacity":494384795648,"available":346535829504,"partitionCount":0,"graphSize":0,"keyCount":0,"leaderCount":0,"serviceName":"127.0.0.1:8500-store","serviceVersion":"","serviceCreatedTimeStamp":1754027127000,"partitions":[]}],"stateCountMap":{"Up":1},"numOfService":1,"numOfNormalService":1},"status":0} +{ + "message": "OK", + "data": { + "stores": [ + { + "storeId": 8319292642220586694, + "address": "127.0.0.1:8500", + "raftAddress": "127.0.0.1:8510", + "version": "", + "state": "Up", + "deployPath": "/Users/{your_user_name}/hugegraph/apache-hugegraph-incubating-1.5.0/apache-hugegraph-store-incubating-1.5.0/lib/hg-store-node-1.5.0.jar", + "dataPath": "./storage", + "startTimeStamp": 1754027127969, + "registedTimeStamp": 1754027127969, + "lastHeartBeat": 1754027909444, + "capacity": 494384795648, + "available": 346535829504, + "partitionCount": 0, + "graphSize": 0, + "keyCount": 0, + "leaderCount": 0, + "serviceName": "127.0.0.1:8500-store", + "serviceVersion": "", + "serviceCreatedTimeStamp": 1754027127000, + "partitions": [] + } + ], + "stateCountMap": { + "Up": 1 + }, + "numOfService": 1, + "numOfNormalService": 1 + }, + "status": 0 +} ``` From bcb4659f3a2ea1fd2fe146fdf2ed67af5ef866cb Mon Sep 17 00:00:00 2001 From: JisoLya <523420504@qq.com> Date: Mon, 4 Aug 2025 17:31:37 +0800 Subject: [PATCH 3/4] doc:remove unnecessary white space --- content/cn/docs/quickstart/hugegraph/hugegraph-hstore.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/cn/docs/quickstart/hugegraph/hugegraph-hstore.md b/content/cn/docs/quickstart/hugegraph/hugegraph-hstore.md index 9f7f1173d..43e1de275 100644 --- a/content/cn/docs/quickstart/hugegraph/hugegraph-hstore.md +++ b/content/cn/docs/quickstart/hugegraph/hugegraph-hstore.md @@ -216,7 +216,7 @@ curl http://localhost:8620/v1/stores "raftAddress": "127.0.0.1:8510", "version": "", "state": "Up", - "deployPath": "/Users/{your_user_name}/hugegraph/ apache-hugegraph-incubating-1.5.0/apache-hugegraph-store-incubating-1.5.0/lib/hg-store-node-1.5.0.jar", + "deployPath": "/Users/{your_user_name}/hugegraph/apache-hugegraph-incubating-1.5.0/apache-hugegraph-store-incubating-1.5.0/lib/hg-store-node-1.5.0.jar", "dataPath": "./storage", "startTimeStamp": 1754027127969, "registedTimeStamp": 1754027127969, From 47421b507b524e667e59459c74becf6b65a395e2 Mon Sep 17 00:00:00 2001 From: imbajin Date: Tue, 5 Aug 2025 14:24:10 +0800 Subject: [PATCH 4/4] Apply suggestions from code review --- content/cn/docs/quickstart/hugegraph/hugegraph-hstore.md | 2 +- content/en/docs/quickstart/hugegraph/hugegraph-pd.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/cn/docs/quickstart/hugegraph/hugegraph-hstore.md b/content/cn/docs/quickstart/hugegraph/hugegraph-hstore.md index 43e1de275..0e6bbb3d5 100644 --- a/content/cn/docs/quickstart/hugegraph/hugegraph-hstore.md +++ b/content/cn/docs/quickstart/hugegraph/hugegraph-hstore.md @@ -205,7 +205,7 @@ curl http://localhost:8620/v1/stores ``` 如果Store配置成功,上述接口的响应中应该包含当前节点的状态信息,状态为Up表示节点正常运行,这里只展示了一个节点配置成功的响应,如果三个节点都配置成功并正在运行,响应中`storeId`列表应该包含三个id,并且`stateCountMap`中`Up`、`numOfService`、`numOfNormalService`三个字段应该为3。 -```JSON +```javascript { "message": "OK", "data": { diff --git a/content/en/docs/quickstart/hugegraph/hugegraph-pd.md b/content/en/docs/quickstart/hugegraph/hugegraph-pd.md index 5880ae169..7a520a6d9 100644 --- a/content/en/docs/quickstart/hugegraph/hugegraph-pd.md +++ b/content/en/docs/quickstart/hugegraph/hugegraph-pd.md @@ -145,7 +145,7 @@ curl http://localhost:8620/v1/stores If the Store is configured successfully, the response of the above interface should contain the status information of the current node. The status "Up" indicates that the node is running normally. Only the response of one node configuration is shown here. If all three nodes are configured successfully and are running, the `storeId` list in the response should contain three IDs, and the `Up`, `numOfService`, and `numOfNormalService` fields in `stateCountMap` should be 3. -```JSON +```javascript { "message": "OK", "data": {