Skip to content

Commit 485140a

Browse files
authored
[Docs] update rest-api doc (apache#7111)
1 parent 2e81cb1 commit 485140a

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

docs/en/seatunnel-engine/rest-api.md

+10
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,9 @@ network:
3737

3838
### Returns an overview over the Zeta engine cluster.
3939

40+
<details>
41+
<summary><code>GET</code> <code><b>/hazelcast/rest/maps/overview</b></code> <code>(Returns an overview over the Zeta engine cluster.)</code></summary>
42+
4043
#### Parameters
4144

4245
#### Responses
@@ -55,6 +58,13 @@ network:
5558
}
5659
```
5760

61+
If you use `dynamic-slot`, the `totalSlot` and `unassignedSlot` always be `0`.
62+
If you set it to fix slot number, it will return the correct total and unassigned slot number
63+
64+
</details>
65+
66+
------------------------------------------------------------------------------------------
67+
5868
### Returns an overview over all jobs and their current state.
5969

6070
<details>

docs/zh/seatunnel-engine/rest-api.md

+10
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,9 @@ network:
3636

3737
### 返回Zeta集群的概览
3838

39+
<details>
40+
<summary><code>GET</code> <code><b>/hazelcast/rest/maps/overview</b></code> <code>(Returns an overview over the Zeta engine cluster.)</code></summary>
41+
3942
#### 参数
4043

4144
#### 响应
@@ -54,6 +57,13 @@ network:
5457
}
5558
```
5659

60+
当你使用`dynamic-slot`时, 返回结果中的`totalSlot`和`unassignedSlot`将始终为0.
61+
当你设置为固定的slot值时, 将正确返回集群中总共的slot数量以及未分配的slot数量.
62+
63+
</details>
64+
65+
------------------------------------------------------------------------------------------
66+
5767
### 返回所有作业及其当前状态的概览。
5868

5969
<details>

0 commit comments

Comments
 (0)