Skip to content

Commit 9478a90

Browse files
committed
Document 'ready-to-serve-clients' API health check
1 parent 967fc43 commit 9478a90

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/http-api-reference.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1708,6 +1708,19 @@ Responds a 200 OK if the target node has fewer connections to the AMQP
17081708
and AMQPS ports than the configured maximum, otherwise responds with a
17091709
503 Service Unavailable.
17101710

1711+
### GET /api/health/checks/ready-to-serve-clients
1712+
1713+
Responds a 200 OK if the target node is ready to serve clients, otherwise
1714+
responds with a 503 Service Unavailable. This check combines:
1715+
1716+
* `/api/health/checks/is-in-service`
1717+
* `/api/health/checks/protocol-listener/amqp` or `/api/health/checks/protocol-listener/amqps`
1718+
* `/api/health/checks/below-node-connection-limit`
1719+
1720+
So this check will only return 200 OK if the target node is in service,
1721+
an AMQP or AMQPS listener is available and the target node has fewer active
1722+
AMQP and AMQPS connections that its configured limit.
1723+
17111724
### GET /api/rebalance/queues
17121725

17131726
Rebalances all queues in all vhosts.

0 commit comments

Comments
 (0)