Updated API (markdown)

Benjamin Roth 2017-01-25 13:16:59 +01:00
parent f2620122e1
commit 2e2f53a7c8

25
API.md

@ -206,6 +206,31 @@ This generates volume 3 on this volume server.
If you use other replicationType, e.g. 001, you would need to do the same on other volume servers to create the mirroring volumes. If you use other replicationType, e.g. 001, you would need to do the same on other volume servers to create the mirroring volumes.
### Delete а volume
This API should be protected just in case someone delete your volumes!
It deletes the volume physically.
```bash
curl "http://localhost:8080/admin/volume/delete?volume=volumeId"
```
### Unmount/mount а volume
This API should be protected!
This deactivates a given volume. This is useful to process a volume stopping the volume server. Possible use cases are compaction, index recreation or moving the volume to another server. As soon as a volume is unmounted it won't be accessed by the volume any more and can be safely changed or moved away.
```bash
curl "http://localhost:8080/admin/volume/unmount?volume=volumeId"
```
The counterpart is to mount a volume. This adds a volume file to a volume server without the need to restart the volume server. A use case is to mount a previously unmounted volume again or to add a volume, that has been moved to another server to the new server.
```bash
curl "http://localhost:8080/admin/volume/mount?volume=volumeId"
```
### Delete а specific collection on a specific volume server ### Delete а specific collection on a specific volume server
This API should be protected just in case someone delete your volumes! This API should be protected just in case someone delete your volumes!