Page History
| Warning | ||
|---|---|---|
| ||
This page is in development and as such, its contents may be incorrect |
| Warning | ||
|---|---|---|
| ||
This is an internal API used for 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.
| Table of Contents |
|---|
| Section | |||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Release one or moreworkersseedsReset the status of any in memory batches that were sent to a failed worker but had not been acknowledged so the may be sent to another worker
Path and Request Body Parameters | |||||||||||||||||||||||||||||||||||||||||
| Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||
| id | string | Required | The identifier(s) of the failed worker node(s) whose batches must be reset |
| Code Block | ||
|---|---|---|
| ||
{
"message": "optional response message"
} |
Status
Release one or more seeds
Used by the master 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 workersReleases all the items currently not being processed, setting their status to be available, so the worker node stops processing a seed promptly when that seed is paused/stopped
| Panel | ||||
|---|---|---|---|---|
| ||||
|
Path and Request Body Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | Required | The identifier(s) of the seed to be released |
Examples
Release a single seed
| Code Block | ||
|---|---|---|
| ||
{
"id": "AAABcID5GBc="
} |
Release multiple seeds
| Code Block | ||
|---|---|---|
| ||
[{
"id": "AAABcID5GBc="
},
{
"id": "AAABcIueWUc="
}] |
Release multiple seeds (alternative form)
| Code Block | ||
|---|---|---|
| ||
{
"id": ["AAABcID5GBc=", "AAABcIueWUc="]
} |
Response
| Code Block | ||
|---|---|---|
| ||
{
"message": "optional response message"
} |
Status
| Response code | Description |
|---|---|
| 200 | Success |
| 404 | The given seed id was not found |
Fetch one or more batches
Used by the worker to fetch a batch from the manager.
| Panel | ||||
|---|---|---|---|---|
| ||||
|
Path and Request Body Parameters
Response
| Code Block | ||
|---|---|---|
| ||
{
<TODO>
"message": "optional response message"
} |
Status
Acknowledge one or more batches
Used by the worker node to acknowledge the worker has taken responsibility for the batch(es)
| Panel | ||||
|---|---|---|---|---|
| ||||
|
Path and Request Body Parameters
Examples
Acknowledge a single batch
| Code Block | ||
|---|---|---|
| ||
{
"id": "AAABcID5GBc="
} |
Acknowledge multiple batches
| Code Block | ||
|---|---|---|
| ||
[{
"id": "AAABcID5GBc="
},
{
"id": "AAABcIueWUc="
}] |
Acknowledge multiple batches (alternative form)
| Code Block | ||
|---|---|---|
| ||
{
"id": ["AAABcID5GBc=", "AAABcIueWUc="]
} |
Response
| Code Block | ||
|---|---|---|
| ||
{
"message": "optional response message"
} |
Status
| Response code | Description |
|---|---|
| 200 | Success |
| 404 | The given batch id was not found |
Overview
Content Tools