Warning | ||
---|---|---|
| ||
This is an internal API used for the communication between nodes and is not expected to be used by others. |
The manager node API provides functionality that allows a manager and worker nodes to communicate.
Easy Heading Free | ||||
---|---|---|---|---|
|
Section | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Release one or more workersReset the status of any in memory batches that were sent to a failed worker but had not been acknowledged, so the they may be sent to another worker, this endpoint need the . This endpoint needs at least the ADMINISTRATOR or MANAGER role to be executed.
Path and Request Body Parameters
Examples Release a single worker
Release more workers
Status: 200, 404 |
Section | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Release one or more seedsUsed by the main manager when pausing or stopping to release all of the items for a seed from unsent batches. The manager will then forward the same to the workers, this endpoint need the . This endpoint needs at least the ADMINISTRATOR or MANAGER role to be executed.
Path and Request Body Parameters
Examples Release a single seed
Release multiple seeds
Response
Status: 200, 404 |
Section | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Fetch one or more batchesUsed by the worker to fetch a batch from the manager, this endpoint need the . This endpoint needs at least the ADMINISTRATOR or WORKER role to be executed.
Path and Request Body Parameters
Response
Status: 200, 406 |
Section | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Acknowledge one or more batchesUsed by the worker node to acknowledge the worker has taken responsibility for the batch(es), this endpoint need the . This endpoint needs at least the ADMINISTRATOR or WORKER role to be executed.
Query String Parameters
Path and Request Body Parameters
Examples Acknowledge a single batch
Acknowledge multiple batches
Response
Status: 200, 404 |
Section | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Re-balance seed allocationAllows an administrator to manually re-balance the seed to manager manage allocation for active crawls. This endpoint needs the ADMINISTRATOR role to be executed
Status: 200 |
Section | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Crawl failed actionAllows to handle handling the crawl failed state for the seed. This endpoint needs the ADMINISTRATOR or WORKER role to be executed
Status: 200, 404 |