Github-Mirror/seaweedfs
1
0 Fork 0
mirror of https://github.com/seaweedfs/seaweedfs.git synced 2026-11-05 11:37:44 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: add /healthz endpoint documentation for volume server 

Documents the healthz endpoint behavior after the fix for issue #6823.
The endpoint now only checks local conditions (shutting down, master
connectivity) and will not fail due to other volume servers being
unavailable.
chrislusf committed 2025-12-02 22:58:03 -08:00
1 parent 487e96f640
commit c082321e74
1 file changed
+13
Download Patch File Download Diff File Expand all files Collapse all files
Volume-Server-API.md
+13
@@ -74,6 +74,19 @@ curl -X DELETE http://127.0.0.1:8080/3,01637037d6
curl http://127.0.0.1:8080/3,01637037d6?cm=false
```
### Check Volume Server Health
The `/healthz` endpoint checks if the volume server is healthy. It returns:
- `200 OK` - Server is healthy
- `503 Service Unavailable` - Server is unhealthy (shutting down or lost connection to master)
```bash
curl -I "http://localhost:8080/healthz"
HTTP/1.1 200 OK
```
This endpoint is suitable for Kubernetes liveness and readiness probes. It only checks local server conditions and will not fail due to other volume servers being unavailable.
### Check Volume Server Status
```bash