Page in development
This page is in development and as such, its contents may be incorrect
Internal API
This is an internal API used for 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.
Release one or more workers
Reset 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, this endpoint need the at least the ADMINISTRATOR or MANAGER role to be executed.
PUT /aspire/_api/manager/release/worker/:id
PUT /aspire/_api/manager/release/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 |
Response
{
"message": "optional response message"
}
Status
| Response code | Description |
|---|---|
| 200 | Success |
| 404 | The given worker id was not found |
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 workers, this endpoint need the at least the ADMINISTRATOR or MANAGER role to be executed.
PUT /aspire/_api/manager/release/seed/:id
PUT /aspire/_api/manager/release/seed
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
{
"id": "AAABcID5GBc="
}
Release multiple seeds
[{
"id": "AAABcID5GBc="
},
{
"id": "AAABcIueWUc="
}]
Release multiple seeds (alternative form)
{
"id": ["AAABcID5GBc=", "AAABcIueWUc="]
}
Response
{
"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, this endpoint need the at least the ADMINISTRATOR or WORKER role to be executed.
GET /aspire/_api/manager/batch
Path and Request Body Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| worker | string | Required | The id of the worker asking for the batch |
| type | string | Required | The type of batch required
|
| tags | string | Optional | The tags this machine has |
| batches | number | Optional | The number of batches to fetch (default 1) |
Response
{
"batch": {
"id": 0,
"type": "process",
"connector": "myConnectorId",
"entry": [{
"_id": "item_id_1",
"url": "item_url_1",
"type": "com.accenture.aspire.connector.manager.ManagerComponent$FSItemType@filesystem",
"status": "A",
"action": "add",
"timestamp": 1234567890,
"shouldScan": true,
"shouldProcess": true,
"crawlRetries": 0,
"isCrawlRootItem": false,
"inCrawlRetries": 0
}, {
"_id": "item_id_2",
"url": "item_url_2",
"type": "com.accenture.aspire.connector.manager.ManagerComponent$FSItemType@folder",
"status": "A",
"action": "update",
"timestamp": 1234567890,
"shouldScan": true,
"shouldProcess": true,
"crawlRetries": 0,
"isCrawlRootItem": false,
"inCrawlRetries": 0
}]
},
"message": "optional response message"
}
Status
| Response code | Description |
|---|---|
| 200 | Success |
| 406 | Not acceptable - there was an issue validating the input |
Acknowledge one or more batches
Used by the worker node to acknowledge the worker has taken responsibility for the batch(es), this endpoint need the at least the ADMINISTRATOR or WORKER role to be executed.
PUT /aspire/_api/manager/batch/ack/:id
PUT /aspire/_api/manager/batch/ack
Query String Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| type | string | Required | The type of the batch
|
Path and Request Body Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | Required | The identifier(s) of the batch(es) to be acknowledged |
Examples
Acknowledge a single batch
PUT /aspire/_api/manager/batch/ack/AAABcID5GBc=?type=scan
PUT /aspire/_api/manager/batch/ack?type=scan
{
"id": "AAABcID5GBc="
}
Acknowledge multiple batches
PUT /aspire/_api/manager/batch/ack?type=scan
[{
"id": "AAABcID5GBc="
},
{
"id": "AAABcIueWUc="
}]
Acknowledge multiple batches (alternative form)
PUT /aspire/_api/manager/batch/ack?type=scan
{
"id": ["AAABcID5GBc=", "AAABcIueWUc="]
}
Response
{
"message": "optional response message"
}
Status
| Response code | Description |
|---|---|
| 200 | Success |
| 404 | The given batch id was not found |
Overview
Content Tools
Copyright © 2024 Accenture
