This is an automated email from the ASF dual-hosted git repository.
luzhijing pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/doris-website.git
The following commit(s) were added to refs/heads/master by this push:
new bf6c9f34370 Update wal api doc (#954)
bf6c9f34370 is described below
commit bf6c9f343704a022ca1967643034ebd1117c6f5c
Author: abmdocrt <yukang.lian2...@gmail.com>
AuthorDate: Wed Aug 14 17:36:01 2024 +0800
Update wal api doc (#954)
---
.../current/admin-manual/fe/get-wal-size-action.md | 95 ++++++++++++++++++++++
.../admin-manual/fe/get-wal-size-action.md | 95 ++++++++++++++++++++++
.../admin-manual/fe/get-wal-size-action.md | 95 ++++++++++++++++++++++
.../admin-manual/fe/get-wal-size-action.md | 94 +++++++++++++++++++++
.../admin-manual/fe/get-wal-size-action.md | 94 +++++++++++++++++++++
versioned_sidebars/version-2.1-sidebars.json | 1 +
versioned_sidebars/version-3.0-sidebars.json | 1 +
7 files changed, 475 insertions(+)
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/fe/get-wal-size-action.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/fe/get-wal-size-action.md
new file mode 100644
index 00000000000..42dca337954
--- /dev/null
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/fe/get-wal-size-action.md
@@ -0,0 +1,95 @@
+---
+{
+ "title": "Get WAL size",
+ "language": "zh-CN"
+}
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+
+
+
+## Request
+
+`GET
fe_host:fe_http_port/api/get_wal_size?host_ports=host1:port1,host2:port2...`
+
+## Description
+
+用户可以通过该 HTTP 接口获取指定BE的WAL文件的数目，若不指定BE，则默认返回所有BE的WAL文件的数目。
+
+## Path parameters
+
+无
+
+## Query parameters
+
+* `host_ports`
+
+ BE的ip和http端口。
+
+## Request body
+
+无
+
+## Response
+
+```
+{
+"msg": "OK",
+"code": 0,
+"data": ["192.168.10.11:9050:1", "192.168.10.11:9050:0"],
+"count": 0
+}
+```
+
+## Examples
+
+1. 获取所有BE的WAL文件的数目。
+
+ ```
+ curl -u root: "127.0.0.1:8038/api/get_wal_size"
+
+ Response:
+ {
+ "msg": "OK",
+ "code": 0,
+ "data": ["192.168.10.11:9050:1", "192.168.10.11:9050:0"],
+ "count": 0
+ }
+ ```
+
+ 在返回的结果中，BE后跟的数字即为对应BE的WAL文件数目。
+
+2. 获取指定BE的WAL文件的数目。
+
+ ```
+ curl -u root: "127.0.0.1:8038/api/get_wal_size?192.168.10.11:9050"
+
+ Response:
+ {
+ "msg": "OK",
+ "code": 0,
+ "data": ["192.168.10.11:9050:1"],
+ "count": 0
+ }
+ ```
+
+ 在返回的结果中，BE后跟的数字即为对应BE的WAL文件数目。
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/admin-manual/fe/get-wal-size-action.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/admin-manual/fe/get-wal-size-action.md
new file mode 100644
index 00000000000..42dca337954
--- /dev/null
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/admin-manual/fe/get-wal-size-action.md
@@ -0,0 +1,95 @@
+---
+{
+ "title": "Get WAL size",
+ "language": "zh-CN"
+}
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+
+
+
+## Request
+
+`GET
fe_host:fe_http_port/api/get_wal_size?host_ports=host1:port1,host2:port2...`
+
+## Description
+
+用户可以通过该 HTTP 接口获取指定BE的WAL文件的数目，若不指定BE，则默认返回所有BE的WAL文件的数目。
+
+## Path parameters
+
+无
+
+## Query parameters
+
+* `host_ports`
+
+ BE的ip和http端口。
+
+## Request body
+
+无
+
+## Response
+
+```
+{
+"msg": "OK",
+"code": 0,
+"data": ["192.168.10.11:9050:1", "192.168.10.11:9050:0"],
+"count": 0
+}
+```
+
+## Examples
+
+1. 获取所有BE的WAL文件的数目。
+
+ ```
+ curl -u root: "127.0.0.1:8038/api/get_wal_size"
+
+ Response:
+ {
+ "msg": "OK",
+ "code": 0,
+ "data": ["192.168.10.11:9050:1", "192.168.10.11:9050:0"],
+ "count": 0
+ }
+ ```
+
+ 在返回的结果中，BE后跟的数字即为对应BE的WAL文件数目。
+
+2. 获取指定BE的WAL文件的数目。
+
+ ```
+ curl -u root: "127.0.0.1:8038/api/get_wal_size?192.168.10.11:9050"
+
+ Response:
+ {
+ "msg": "OK",
+ "code": 0,
+ "data": ["192.168.10.11:9050:1"],
+ "count": 0
+ }
+ ```
+
+ 在返回的结果中，BE后跟的数字即为对应BE的WAL文件数目。
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/admin-manual/fe/get-wal-size-action.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/admin-manual/fe/get-wal-size-action.md
new file mode 100644
index 00000000000..42dca337954
--- /dev/null
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/admin-manual/fe/get-wal-size-action.md
@@ -0,0 +1,95 @@
+---
+{
+ "title": "Get WAL size",
+ "language": "zh-CN"
+}
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+
+
+
+## Request
+
+`GET
fe_host:fe_http_port/api/get_wal_size?host_ports=host1:port1,host2:port2...`
+
+## Description
+
+用户可以通过该 HTTP 接口获取指定BE的WAL文件的数目，若不指定BE，则默认返回所有BE的WAL文件的数目。
+
+## Path parameters
+
+无
+
+## Query parameters
+
+* `host_ports`
+
+ BE的ip和http端口。
+
+## Request body
+
+无
+
+## Response
+
+```
+{
+"msg": "OK",
+"code": 0,
+"data": ["192.168.10.11:9050:1", "192.168.10.11:9050:0"],
+"count": 0
+}
+```
+
+## Examples
+
+1. 获取所有BE的WAL文件的数目。
+
+ ```
+ curl -u root: "127.0.0.1:8038/api/get_wal_size"
+
+ Response:
+ {
+ "msg": "OK",
+ "code": 0,
+ "data": ["192.168.10.11:9050:1", "192.168.10.11:9050:0"],
+ "count": 0
+ }
+ ```
+
+ 在返回的结果中，BE后跟的数字即为对应BE的WAL文件数目。
+
+2. 获取指定BE的WAL文件的数目。
+
+ ```
+ curl -u root: "127.0.0.1:8038/api/get_wal_size?192.168.10.11:9050"
+
+ Response:
+ {
+ "msg": "OK",
+ "code": 0,
+ "data": ["192.168.10.11:9050:1"],
+ "count": 0
+ }
+ ```
+
+ 在返回的结果中，BE后跟的数字即为对应BE的WAL文件数目。
diff --git a/versioned_docs/version-2.1/admin-manual/fe/get-wal-size-action.md
b/versioned_docs/version-2.1/admin-manual/fe/get-wal-size-action.md
new file mode 100644
index 00000000000..637a7515b79
--- /dev/null
+++ b/versioned_docs/version-2.1/admin-manual/fe/get-wal-size-action.md
@@ -0,0 +1,94 @@
+---
+{
+ "title": "Get Small File Action",
+ "language": "en"
+}
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+# Get WAL size
+
+## Request
+
+`GET
fe_host:fe_http_port/api/get_wal_size?host_ports=host1:port1,host2:port2...`
+
+## Description
+
+This HTTP interface allows users to obtain the number of WAL files for
specified Backends (BEs). If no BE is specified, it returns the number of WAL
files for all BEs.
+
+## Path parameters
+
+None
+
+## Query parameters
+
+* `host_ports`
+
+ The IP and HTTP port of the BE.
+
+## Request body
+
+None
+
+## Response
+
+```
+{
+"msg": "OK",
+"code": 0,
+"data": ["192.168.10.11:9050:1", "192.168.10.11:9050:0"],
+"count": 0
+}
+```
+
+## Examples
+
+1. To obtain the number of WAL files for all BEs.
+
+ ```
+ curl -u root: "127.0.0.1:8038/api/get_wal_size"
+
+ Response:
+ {
+ "msg": "OK",
+ "code": 0,
+ "data": ["192.168.10.11:9050:1", "192.168.10.11:9050:0"],
+ "count": 0
+ }
+ ```
+
+ In the returned result, the number following each BE indicates the number
of WAL files for that BE.
+
+2. To obtain the number of WAL files for a specified BE.
+
+ ```
+ curl -u root: "127.0.0.1:8038/api/get_wal_size?192.168.10.11:9050"
+
+ Response:
+ {
+ "msg": "OK",
+ "code": 0,
+ "data": ["192.168.10.11:9050:1"],
+ "count": 0
+ }
+ ```
+
+ In the returned result, the number following the BE indicates the number
of WAL files for that BE.
diff --git a/versioned_docs/version-3.0/admin-manual/fe/get-wal-size-action.md
b/versioned_docs/version-3.0/admin-manual/fe/get-wal-size-action.md
new file mode 100644
index 00000000000..637a7515b79
--- /dev/null
+++ b/versioned_docs/version-3.0/admin-manual/fe/get-wal-size-action.md
@@ -0,0 +1,94 @@
+---
+{
+ "title": "Get Small File Action",
+ "language": "en"
+}
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+# Get WAL size
+
+## Request
+
+`GET
fe_host:fe_http_port/api/get_wal_size?host_ports=host1:port1,host2:port2...`
+
+## Description
+
+This HTTP interface allows users to obtain the number of WAL files for
specified Backends (BEs). If no BE is specified, it returns the number of WAL
files for all BEs.
+
+## Path parameters
+
+None
+
+## Query parameters
+
+* `host_ports`
+
+ The IP and HTTP port of the BE.
+
+## Request body
+
+None
+
+## Response
+
+```
+{
+"msg": "OK",
+"code": 0,
+"data": ["192.168.10.11:9050:1", "192.168.10.11:9050:0"],
+"count": 0
+}
+```
+
+## Examples
+
+1. To obtain the number of WAL files for all BEs.
+
+ ```
+ curl -u root: "127.0.0.1:8038/api/get_wal_size"
+
+ Response:
+ {
+ "msg": "OK",
+ "code": 0,
+ "data": ["192.168.10.11:9050:1", "192.168.10.11:9050:0"],
+ "count": 0
+ }
+ ```
+
+ In the returned result, the number following each BE indicates the number
of WAL files for that BE.
+
+2. To obtain the number of WAL files for a specified BE.
+
+ ```
+ curl -u root: "127.0.0.1:8038/api/get_wal_size?192.168.10.11:9050"
+
+ Response:
+ {
+ "msg": "OK",
+ "code": 0,
+ "data": ["192.168.10.11:9050:1"],
+ "count": 0
+ }
+ ```
+
+ In the returned result, the number following the BE indicates the number
of WAL files for that BE.
diff --git a/versioned_sidebars/version-2.1-sidebars.json
b/versioned_sidebars/version-2.1-sidebars.json
index 05f3d3c5e03..140bbc6fa96 100644
--- a/versioned_sidebars/version-2.1-sidebars.json
+++ b/versioned_sidebars/version-2.1-sidebars.json
@@ -437,6 +437,7 @@
"admin-manual/fe/get-load-state",
"admin-manual/fe/get-log-file-action",
"admin-manual/fe/get-small-file",
+ "admin-manual/fe/get-wal-size-action",
"admin-manual/fe/health-action",
"admin-manual/fe/meta-info-action",
"admin-manual/fe/meta-replay-state-action",
diff --git a/versioned_sidebars/version-3.0-sidebars.json
b/versioned_sidebars/version-3.0-sidebars.json
index 284b0e48e71..d76819cdf26 100644
--- a/versioned_sidebars/version-3.0-sidebars.json
+++ b/versioned_sidebars/version-3.0-sidebars.json
@@ -463,6 +463,7 @@
"admin-manual/fe/get-load-state",
"admin-manual/fe/get-log-file-action",
"admin-manual/fe/get-small-file",
+ "admin-manual/fe/get-wal-size-action",
"admin-manual/fe/health-action",
"admin-manual/fe/meta-info-action",
"admin-manual/fe/meta-replay-state-action",
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@doris.apache.org
For additional commands, e-mail: commits-h...@doris.apache.org
