Warning | ||
---|---|---|
| ||
This page is in development and as such, its contents may be incorrectis an internal API used for the communication between nodes and is not expected to be used by others. |
The manager node The connector API provides functionality that allows a administrator to perform actions such as adding and configuring connectorsmanager 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 needs at least the ADMINISTRATOR or MANAGER role to be executed.
Path and Request Body Parameters
Examples Release a single worker
Release more workers
| ||||||||||||||||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||||||||||||||||
200 | Success | 404 | The given worker id was not found
Section | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Release one or more seedsUsed by the master 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 needs at least the ADMINISTRATOR or MANAGER role to be executed.
Path and Request Body Parameters
Examples Release a single seed
Release multiple seeds
Release multiple seeds (alternative form)
Response
| ||||||||||||||||||||||||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||||||||||||||||||||||||
200 | Success | |||||||||||||||||||||||||||||||||||||||||||
404 | The given seed id was not found |
Section | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Fetch one or more batchesUsed by the worker to fetch a batch from the manager. This endpoint needs at least the ADMINISTRATOR or WORKER role to be executed.
Path and Request Body Parameters
Response
| ||||||||||||||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||||||||||||||
200 | Success | |||||||||||||||||||||||||||||||||
404 | Not found - a given connector identifier was not found | 406 | Not acceptable - there was an issue validating the input
Section | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Acknowledge one or more batchesUsed by the worker node to acknowledge the worker has taken responsibility for the batch(es). 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 manage allocation for active crawls. This endpoint needs the ADMINISTRATOR role to be executed
Status: 200 |
Section | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Crawl failed actionAllows handling the crawl failed state for the seed. This endpoint needs the ADMINISTRATOR or WORKER role to be executed
Status: 200, 404 |
Section | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Throttle notification (Aspire 5.3)Allows handling the throttle event happening in the connector for the seed. This endpoint needs the ADMINISTRATOR or WORKER role to be executed
Path and Request Body Parameters
| Description | ||||||||||||||||||||
200 | Success | 404 | The given batch id was not found
| ||||
{
"message": "optional response message"
} |
Status: 200, 404