[Feature][Rest Api] Additional rest api documentation. (#7645)

Co-authored-by: gdliu3 <[email protected]>
apache · Sep 13, 2024 · 154e866 · 154e866
1 parent 6b36f90
commit 154e866
Show file tree

Hide file tree

Showing 2 changed files with 59 additions and 0 deletions.
diff --git a/docs/en/seatunnel-engine/rest-api.md b/docs/en/seatunnel-engine/rest-api.md
@@ -69,6 +69,33 @@ network:
 
 ------------------------------------------------------------------------------------------
 
+###  Returns thread dump information for the current node.
+
+<details>
+ <summary><code>GET</code> <code><b>/hazelcast/rest/maps/thread-dump</b></code> <code>(Returns thread dump information for the current node.)</code></summary>
+
+#### Parameters
+
+
+#### Responses
+
+```json
+[
+  {
+    "threadName": "",
+    "threadId": 0,
+    "threadState": "",
+    "stackTrace": ""
+  }
+]
+```
+
+</details>
+
+------------------------------------------------------------------------------------------
+
+
+
 ### Returns An Overview And State Of All Jobs
 
 <details>
@@ -278,6 +305,9 @@ When we can't get the job info, the response will be:
 ```json
 [
   {
+    "isMaster": "true",
+    "host": "localhost",
+    "port": "5801",
     "processors":"8",
     "physical.memory.total":"16.0G",
     "physical.memory.free":"16.3M",

diff --git a/docs/zh/seatunnel-engine/rest-api.md b/docs/zh/seatunnel-engine/rest-api.md
@@ -68,6 +68,32 @@ network:
 
 ------------------------------------------------------------------------------------------
 
+###  返回当前节点的线程堆栈信息。
+
+<details>
+ <summary><code>GET</code> <code><b>/hazelcast/rest/maps/thread-dump</b></code> <code>(返回当前节点的线程堆栈信息。)</code></summary>
+
+#### Parameters
+
+
+#### Responses
+
+```json
+[
+  {
+    "threadName": "",
+    "threadId": 0,
+    "threadState": "",
+    "stackTrace": ""
+  }
+]
+```
+
+</details>
+
+------------------------------------------------------------------------------------------
+
+
 ### 返回所有作业及其当前状态的概览
 
 <details>
@@ -277,6 +303,9 @@ network:
 ```json
 [
   {
+    "isMaster": "true",
+    "host": "localhost",
+    "port": "5801",
     "processors":"8",
     "physical.memory.total":"16.0G",
     "physical.memory.free":"16.3M",