Warning

title	Page in developmentInternal API

This page is in development and as such, its contents may be incorrectis an internal API used for communication between nodes and is not expected to be used by others

The worker node The connector API provides functionality that allows a administrator to perform actions such as adding and configuring connectorsmanager and worker nodes to communicate.

toc

Easy Heading Free

navigationTitle	On this Page
navigationExpandOption	expand-all-by-default

Examples

Release a single seed

Section

Release one or more

workers

seeds

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 workerReleases 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, this endpoint need the at least the ADMINISTRATOR or MANAGER role to be executed.

Panel

borderColor	black
bgColor	#fafafb

GET PUT /aspire/_api/managerworker/release/workerseed/:id

PUT /aspire/_api/manager/release/worker/:idPUT /aspire_api/manager/release/workerseed

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

Code Block

language	js

{
  "message": "optional response message"
}

Status

Response code Description

200 Success

404 The given worker id was not found

Section

seed to be released

Examples

Release a single seed

Code Block

language	js
theme	RDark

PUT /aspire/_api/worker/release/seed/AAABcID5GBc=
 
PUT /aspire/_api/worker/release/seed

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

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

Name Type Required Description

id string Required The identifier(s) of the seed to be released

Code Block

language	js

{
  "id": ["AAABcID5GBc="]
}

Release multiple seeds

Code Block

language	js
theme	RDark

PUT /aspire/_api/worker/release/seed[{
  "id": "AAABcID5GBc="
},
{
  "id": "AAABcIueWUc="
}]

Release multiple seeds (alternative form)

Code Block

language	js

{
  "id": ["AAABcID5GBc=", "AAABcIueWUc="]
}

Response

Code Block

language	js
theme	RDark

{
  "message": "optional response message"
}

Status

Response codeDescription200Success404The given seed id was not found Section

Fetch one or more batches

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

Panel

borderColor	black
bgColor	#fafafb

GET /aspire_api/manager/batch

Path and Request Body Parameters

: 200, 404

Response

Section
Throttle notification (Aspire 5.3) Releases all the items currently not being processed, setting their status to be available, this endpoint need the at least the ADMINISTRATOR or MANAGER role to be executed.
Name	Type	Required	Description
tags	string	Optional	The tags this machine has
batches	number	Optional	The number of batches to fetch (default 1)

Code Block

language	js

{
  <TODO>
  "message": "optional response message"
}

Status

Response codeDescription200Success404Not found - a given connector identifier was not found406Not 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

borderColor	black
bgColor	#fafafb

GET PUT /aspire_api/manager/batch/ack/:idPUT /aspire_api/managerworker/batch/ackthrottle/:id

PUT /aspire_api/manager/batch/ack

seedId

Path and Request Body Parameters

Name	Type	Required	Description
idseedId	string	Required	The identifier(s) of the seed to be released

ExamplesAcknowledge a single batch

Code Block

language	js

{
  "id": "AAABcID5GBc="
}

Acknowledge multiple batches

Code Block

language	js

[{
  "id": "AAABcID5GBc="
},
{
  "id": "AAABcIueWUc="
}]

theme	RDark

PUT /aspire/_api/worker/throttle/AAABcID5GBc=

ResponseAcknowledge multiple batches (alternative form)

Code Block

language	js

{
  "id": ["AAABcID5GBc=", "AAABcIueWUc="]
}

Response

theme	RDark

Code Block

language	js

{
  "message": "optional response message"
}

Status

Response codeDescription200Success404The given batch id was not found

: 200, 404

Page tree

Versions Compared

Old Version 1

New Version Current

Key

Release one or more

seeds

Release one or more seeds

Fetch one or more batches

Throttle notification (Aspire 5.3)

Acknowledge one or more batches

Page tree

Page History

Versions Compared

Old Version 1

New Version Current

Key

Release one or more

seeds

Release one or more seeds

Fetch one or more batches

Throttle notification (Aspire 5.3)

Acknowledge one or more batches