This is an automated email from the ASF dual-hosted git repository.
gavinchou 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 5d4c9f4e60e [Fix](doc) Fix invalid get wal size action api (#2366)
5d4c9f4e60e is described below
commit 5d4c9f4e60eb290fe24af7c60020614b8604767e
Author: abmdocrt <[email protected]>
AuthorDate: Fri Jun 13 03:14:19 2025 +0800
[Fix](doc) Fix invalid get wal size action api (#2366)
---
.../open-api/fe-http/get-wal-size-action.md | 95 ++++++++++++++++++++++
.../open-api/fe-http/get-wal-size-action.md | 95 ++++++++++++++++++++++
.../open-api/fe-http/get-wal-size-action.md | 95 ++++++++++++++++++++++
versioned_sidebars/version-2.1-sidebars.json | 1 +
versioned_sidebars/version-3.0-sidebars.json | 1 +
5 files changed, 287 insertions(+)
diff --git a/docs/admin-manual/open-api/fe-http/get-wal-size-action.md
b/docs/admin-manual/open-api/fe-http/get-wal-size-action.md
new file mode 100644
index 00000000000..90a883a82bf
--- /dev/null
+++ b/docs/admin-manual/open-api/fe-http/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/open-api/fe-http/get-wal-size-action.md
b/versioned_docs/version-2.1/admin-manual/open-api/fe-http/get-wal-size-action.md
new file mode 100644
index 00000000000..90a883a82bf
--- /dev/null
+++
b/versioned_docs/version-2.1/admin-manual/open-api/fe-http/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-3.0/admin-manual/open-api/fe-http/get-wal-size-action.md
b/versioned_docs/version-3.0/admin-manual/open-api/fe-http/get-wal-size-action.md
new file mode 100644
index 00000000000..90a883a82bf
--- /dev/null
+++
b/versioned_docs/version-3.0/admin-manual/open-api/fe-http/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_sidebars/version-2.1-sidebars.json
b/versioned_sidebars/version-2.1-sidebars.json
index 19b2813a440..57ed3b9b4a2 100644
--- a/versioned_sidebars/version-2.1-sidebars.json
+++ b/versioned_sidebars/version-2.1-sidebars.json
@@ -714,6 +714,7 @@
"admin-manual/open-api/fe-http/get-load-state",
"admin-manual/open-api/fe-http/get-log-file-action",
"admin-manual/open-api/fe-http/get-small-file",
+
"admin-manual/open-api/fe-http/get-wal-size-action",
"admin-manual/open-api/fe-http/health-action",
"admin-manual/open-api/fe-http/meta-info-action",
"admin-manual/open-api/fe-http/meta-replay-state-action",
diff --git a/versioned_sidebars/version-3.0-sidebars.json
b/versioned_sidebars/version-3.0-sidebars.json
index 7e459f25404..72b3485f292 100644
--- a/versioned_sidebars/version-3.0-sidebars.json
+++ b/versioned_sidebars/version-3.0-sidebars.json
@@ -767,6 +767,7 @@
"admin-manual/open-api/fe-http/get-load-state",
"admin-manual/open-api/fe-http/get-log-file-action",
"admin-manual/open-api/fe-http/get-small-file",
+
"admin-manual/open-api/fe-http/get-wal-size-action",
"admin-manual/open-api/fe-http/health-action",
"admin-manual/open-api/fe-http/meta-info-action",
"admin-manual/open-api/fe-http/meta-replay-state-action",
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
