hcq/MaxScale
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document the force option for set

Browse Source 
Added documentation for the new option and mentioned it in the release
notes.
This commit is contained in:
Markus Mäkelä
2019-04-02 09:41:55 +03:00
parent ebd2162024
commit 319d9fa1c5
2 changed files with 22 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
Documentation/REST-API/Resources-Server.md
View File

@ -574,6 +574,18 @@ the following URL must be made:
PUT /v1/servers/db-server-1/set?state=maintenance
```
This endpoint also supports the `force=yes` parameter that will cause all
connections to the server to be closed if `state=maintenance` is also set. By
default setting a server into maintenance mode will cause connections to be
closed only after the next request is sent.
The following example forcefully closes all connections to server _db-server-1_
and sets it into maintenance mode:
```
PUT /v1/servers/db-server-1/set?state=maintenance&force=yes
```
#### Response
Server state modified: