The metrics API provides various performance metrics
Fetch one or more batches
Used by the worker to fetch a batch from the manager. This endpoint needs 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 |
| items | number | Optional | The number of items to fetch |
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: 200, 406
Acknowledge one or more batches
Used by the worker node to acknowledge the worker has taken responsibility for the batch(es). This endpoint needs 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=", "AAABcIueWUc="]
}
Response
{
"message": "optional response message"
}
Status: 200, 404
Overview
Content Tools
Copyright © 2024 Accenture
