Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Warning
titlePage in development

This page is in development and as such, its contents may be incorrect

Warning
titlePage in development

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 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

Panel
borderColorblack
bgColor#fafafb

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

NameTypeRequiredDescription
idstringRequiredThe identifier(s) of the failed worker node(s) whose batches must be reset

Response

Code Block
languagejs
{
  "message": "optional response message"
}

Status

Response codeDescription
200Success
404The given worker id was not found




Section

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

Panel
borderColorblack
bgColor#fafafb

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

NameTypeRequiredDescription
idstringRequiredThe identifier(s) of the seed to be released

Examples

Release a single seed

Code Block
languagejs
{
  "id": "AAABcID5GBc="
}

Release multiple seeds

Code Block
languagejs
[{
  "id": "AAABcID5GBc="
},
{
  "id": "AAABcIueWUc="
}]

Release multiple seeds (alternative form)

Code Block
languagejs
{
  "id": ["AAABcID5GBc=", "AAABcIueWUc="]
}

Response

Code Block
languagejs
{
  "message": "optional response message"
}

Status

Response codeDescription
200Success
404The given seed id was not found




Section

Fetch one or more batches

Used by the worker to fetch a batch from the manager.

Panel
borderColorblack
bgColor#fafafb

GET /aspire_api/manager/batch

Path and Request Body Parameters

NameTypeRequiredDescription
tagsstringOptionalThe tags this machine has
batchesnumberOptionalThe number of batches to fetch (default 1)

Response

Code Block
languagejs
{
  <TODO>
  "message": "optional response message"
}

Status

Response codeDescription
200Success
404Not found - a given connector identifier was not found
406Not acceptable - there was an issue validating the input




Section

Acknowledge one or more batches

Used by the worker node to acknowledge the worker has taken responsibility for the batch(es)

Panel
borderColorblack
bgColor#fafafb

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

NameTypeRequiredDescription
idstringRequiredThe identifier(s) of the seed to be released

Examples

Acknowledge a single batch

Code Block
languagejs
{
  "id": "AAABcID5GBc="
}

Acknowledge multiple batches

Code Block
languagejs
[{
  "id": "AAABcID5GBc="
},
{
  "id": "AAABcIueWUc="
}]

Acknowledge multiple batches (alternative form)

Code Block
languagejs
{
  "id": ["AAABcID5GBc=", "AAABcIueWUc="]
}

Response

Code Block
languagejs
{
  "message": "optional response message"
}

Status

Response codeDescription
200Success
404The given batch id was not found