Warning | ||
---|---|---|
| ||
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
Table of Contents |
---|
Section | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Release workerReset 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 List connectorsLists all the connectors configured in the Aspire
Query String Parameters | ||||||||||||||||||||||||||||
Name | Type | Required | Description | |||||||||||||||||||||||||
type | string | Optional | Filter returned connectors to only those with the given type | |||||||||||||||||||||||||
description | string | Optional | Filter returned connectors to only those whose description matches the given expression |
Code Block | ||
---|---|---|
| ||
{
"connector": [{
"id": "AAABcID5GBc=",
"type": "filesystem",
"description": "NetApp connector",
...
},
{
"id": "AAABcIueWUc=",
"type": "shareoint-online",
"description": "SharePoint Online",
...
}],
"message": "optional response message"
} |
Status
|
Path and Request Body
Get information about a single connector configured in Aspire
Panel | ||||
---|---|---|---|---|
| ||||
|
Path Parameters
Name | Type | Required | Description | |
---|---|---|---|---|
id | string | Required | The | id of the connector to returnidentifier(s) of the failed worker node(s) whose batches must be reset |
Response
Code Block | ||
---|---|---|
| ||
{ "connector": { "id": "AAABcID5GBc=", "type": "filesystem", "description": "NetApp connector", ... }, "message": "optional response message" } |
Status
Response code | Description |
---|---|
200 | Success |
404 | The given connector worker id was not found |
Section | |||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Release seedUsed 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 Add connector(s)Add one or more connectors to Aspire
Path and Request Body Parameters
Examples Add Release a single connector seed
Add Release multiple connectors seeds
ResponseRelease multiple seeds (alternative form)
Response
Status
|
Section | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Fetch a batchUsed by the worker to fetch a batch from the manager. Update connectorUpdate a connector in Aspire. Updates will be treated as partial updates rather than overwrites. If a field is not present in the input, any previous value will remain after the update. If you wish to "delete" a value, pass a value of null
Path and Request Body Parameters
Examples Update a single connector
Response
Status
|
Section | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete connectorAcknowledge batch(s)es)Used by the worker node to acknowledge the worker has taken responsibility for the batch(es)Delete one or more connectors from Aspire.
Path and Request Body Parameters
Examples Delete Acknowledge a single connectorbatch
Delete Acknowledge multiple connectorsbatches
Delete Acknowledge multiple connectors batches (alternative form)
Response
Status
|