|
| 1 | + |
| 2 | +@startDocuBlock get_api_shutdown |
| 3 | +@brief query progress of soft shutdown process |
| 4 | + |
| 5 | +@RESTHEADER{GET /_admin/shutdown, Query progress of soft shutdown process, RestGetShutdownHandler} |
| 6 | + |
| 7 | +@RESTDESCRIPTION |
| 8 | +<small>Introduced in: v3.7.12, v3.8.1, v3.9.0</small> |
| 9 | + |
| 10 | +This call reports progress about a soft Coordinator shutdown (see |
| 11 | +documentation of `DELETE /_admin/shutdown?soft=true`). |
| 12 | +In this case, the following types of operations are tracked: |
| 13 | + |
| 14 | + - AQL cursors (in particular streaming cursors) |
| 15 | + - Transactions (in particular stream transactions) |
| 16 | + - Pregel runs (conducted by this Coordinator) |
| 17 | + - Ongoing asynchronous requests (using the `x-arango-async: store` HTTP header |
| 18 | + - Finished asynchronous requests, whose result has not yet been |
| 19 | + collected |
| 20 | + - Queued low priority requests (most normal requests) |
| 21 | + - Ongoing low priority requests |
| 22 | + |
| 23 | +This API is only available on Coordinators. |
| 24 | + |
| 25 | +@RESTRETURNCODES |
| 26 | + |
| 27 | +@RESTRETURNCODE{200} |
| 28 | +The response indicates the fact that a soft shutdown is ongoing and the |
| 29 | +number of active operations of the various types. Once all numbers have gone |
| 30 | +to 0, the flag `allClear` is set and the Coordinator shuts down automatically. |
| 31 | + |
| 32 | +@RESTREPLYBODY{softShutdownOngoing,boolean,required,} |
| 33 | +Whether a soft shutdown of the Coordinator is in progress. |
| 34 | + |
| 35 | +@RESTREPLYBODY{AQLcursors,number,required,} |
| 36 | +Number of AQL cursors that are still active. |
| 37 | + |
| 38 | +@RESTREPLYBODY{transactions,number,required,} |
| 39 | +Number of ongoing transactions. |
| 40 | + |
| 41 | +@RESTREPLYBODY{pendingJobs,number,required,} |
| 42 | +Number of ongoing asynchronous requests. |
| 43 | + |
| 44 | +@RESTREPLYBODY{doneJobs,number,required,} |
| 45 | +Number of finished asynchronous requests, whose result has not yet been collected. |
| 46 | + |
| 47 | +@RESTREPLYBODY{pregelConductors,number,required,} |
| 48 | +Number of ongoing Pregel jobs. |
| 49 | + |
| 50 | +@RESTREPLYBODY{lowPrioOngoingRequests,number,required,} |
| 51 | +Number of queued low priority requests. |
| 52 | + |
| 53 | +@RESTREPLYBODY{lowPrioQueuedRequests,number,required,} |
| 54 | +Number of ongoing low priority requests. |
| 55 | + |
| 56 | +@RESTREPLYBODY{allClear,boolean,required,} |
| 57 | +Whether all active operations finished. |
| 58 | + |
| 59 | +@endDocuBlock |
0 commit comments