GET /api/index/queue/state

Returns information about the number of objects in the Elasticsearch index queue.

Authorization Roles/Permissions: Site Admin only.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/index/queue/state

Back to top

Sample Request

The example below shows a request for the index queue size.

Request URL

https://{hostname}/api/index/queue/state

Sample request headers

Accept: application/json

Sample request body

Not applicable.

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept

Any of the following media types is valid for the Accept header:

application/json, application/xml

application/vnd.soa.v71+json, application/vnd.soa.v71+xml

application/vnd.soa.v72+json, application/vnd.soa.v72+xml

application/vnd.soa.v80+json, application/vnd.soa.v80+xml

Back to top

Request Parameters

None.

Back to top

Response

If successful, this operation returns HTTP status code 200, with information about the number of items in the queue, for local and federation.

Back to top

Sample Response

The sample response below shows successful completion of this operation. There are no items in the queue.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/json
Date: Wed, 05 Oct 2016 19:24:38 GMT

Sample response body: application/json

{
  "LocalIndexQueueSize" : 0,
  "FederationIndexQueueSize" : 0
}

Back to top

Sample response headers: application/xml

Status Code: 200 OK
Content-Type: application/xml
Date:  Wed, 05 Oct 2016 19:26:47 GMT

Sample response body: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<IndexQueueState xmlns="http://soa.com/xsd/search/1.0">
  <LocalIndexQueueSize>0</LocalIndexQueueSize>
  <FederationIndexQueueSize>0</FederationIndexQueueSize>
</IndexQueueState>

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type

application/json, application/xml

application/vnd.soa.v71+json, application/vnd.soa.v71+xml

application/vnd.soa.v72+json, application/vnd.soa.v72+xml

application/vnd.soa.v80+json, application/vnd.soa.v80+xml

Back to top

Response Body

Name Type Description
IndexQueueState IndexQueueState Contains information about the number of objects in the Elasticsearch index queue waiting to be indexed.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
401 Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics