Returns a summary of the index condition of the current node. The returned data consists of:
nodeId - Node identifier.reportTime - Time of this report creation.issueIndex - Summary of the issue index status.replicationQueues - Map of index replication queues, where keys represent nodes from which replication operations came from.externalPlatformIndexReplay - Map of external platform's index replay queues, where keys represents which node logged to index replay queue (journal)issueIndex can contain:
- indexReadable - If false the endpoint failed to read data from the issue index (check Jira logs for detailed stack trace), otherwise true.
- countInDatabase - Count of issues found in the database.
- countInIndex - Count of issues found while querying the index.
- lastUpdatedInDatabase - Time of the last update of the issue found in the database.
- lastUpdatedInIndex - Time of the last update of the issue found while querying the index.
replicationQueues's map values can contain:
- lastConsumedOperation - Last executed index replication operation by the current node from the sending node's queue.
- lastConsumedOperation.id - Identifier of the operation.
- lastConsumedOperation.replicationTime - Time when the operation was sent to other nodes.
- lastOperationInQueue - Last index replication operation in the sending node's queue.
- lastOperationInQueue.id - Identifier of the operation.
- lastOperationInQueue.replicationTime - Time when the operation was sent to other nodes.
- queueSize - Number of operations in the queue from the sending node to the current node.
externalPlatformIndexReplay's map values can contain:
- lastConsumedOperation - Last executed external platform's index replay operation.
- lastConsumedOperation.id - Identifier of the operation.
- lastConsumedOperation.journalWriteTime - Time when the operation was written to the journal.
- lastOperationInQueue - Last external platform's index replay operation in the replay queue.
- lastOperationInQueue.id - Identifier of the operation.
- lastOperationInQueue.journalWriteTime - Time when the operation was written to the journal.
- queueSize - Number of operations in the queue awaiting synchronization with the external platform's index.
Forge and OAuth2 apps cannot access this REST resource.
This request has no parameters.
Returns an object with data about the condition of the Jira node's index
1
2
3
4
curl --request GET \
--url 'http://{baseurl}/rest/api/2/index/summary' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
"externalPlatformIndexReplay": {},
"issueIndex": {
"countInArchive": 2000,
"countInDatabase": 12072,
"countInIndex": 10072,
"indexReadable": true,
"lastUpdatedInDatabase": "2017-07-08T01:46:16.94Z",
"lastUpdatedInIndex": "2017-07-08T00:48:53Z"
},
"nodeId": "node1",
"replicationQueues": {},
"reportTime": "2017-07-08T01:46:16.94Z"
}Rate this page: