Page in development
This page is in development and as such, its contents may be incorrect
The connector API provides functionality that allows a administrator to perform actions such as adding and configuring connectors
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
GET /aspire_api/manager/release/worker/:id
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 |
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
GET /aspire_api/manager/release/seed/:id
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 |
Used by the worker to fetch a batch from the manager.
GET /aspire_api/manager/batch
Path and Request Body Parameters
Name | Type | Required | Description |
---|---|---|---|
tags | string | Optional | The tags this machine has |
Response
{ <TODO> "message": "optional response message" }
Status
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 |
Used by the worker node to acknowledge the worker has taken responsibility for the batch(es)
GET /aspire_api/manager/batch/ack/:id
PUT /aspire_api/manager/batch/ack/:id
PUT /aspire_api/manager/batch/ack
Path and Request Body Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier(s) of the seed to be released |
Examples
Acknowledge a single batch
{ "id": "AAABcID5GBc=" }
Acknowledge multiple batches
[{ "id": "AAABcID5GBc=" }, { "id": "AAABcIueWUc=" }]
Acknowledge multiple batches (alternative form)
{ "id": ["AAABcID5GBc=", "AAABcIueWUc="] }
Response
{ "message": "optional response message" }
Status
Response code | Description |
---|---|
200 | Success |
404 | The given batch id was not found |