The metrics API provides various metrics information
Crawl metrics
Creates basic crawl metrics report. This endpoint needs the ADMINISTRATOR role to be executed.
GET /aspire/_api/metrics/:seedId/:crawlId
Path and Request Body Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| seedId | string | Required | The seed id |
| crawlId | string | Required | The crawl id |
Response
{
"crawl-metrics": {
"seedId": "0dda9332-ca52-44e1-ba63-95e51b46f951",
"crawlId": "1658154843524",
"metrics": {
"add": 3,
"enqueued": 4,
"crawlBegin": 1,
"scanned": 1,
"crawlEnd": 1,
"scannedNotIndexed": 1,
"controlItem": 4
},
"workerDistribution": [
{
"workerId": "worker_192.168.112.1:41443//AAABghGLnak=",
"metrics": {
"add": 3,
"enqueued": 4,
"crawlBegin": 1,
"scanned": 1,
"crawlEnd": 1,
"scannedNotIndexed": 1,
"controlItem": 4
}
}
]
}
}
Status: 200
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
