Indexers - Get Status

Reference

Service:: Search Service

API Version:: 2023-10-01-Preview

Returns the current status and execution history of an indexer.

GET {endpoint}/indexers('{indexerName}')/search.status?api-version=2023-10-01-Preview

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string	The endpoint URL of the search service.
indexerName	path	True	string	The name of the indexer for which to retrieve status.
api-version	query	True	string	Client Api Version.

Request Header

Name	Required	Type	Description
x-ms-client-request-id		string uuid	The tracking ID sent with the request to help with debugging.

Responses

Name	Type	Description
200 OK	SearchIndexerStatus
Other Status Codes	SearchError	Error response.

Examples

SearchServiceGetIndexerStatus

Sample Request

HTTP

GET https://myservice.search.windows.net/indexers('myindexer')/search.status?api-version=2023-10-01-Preview

Sample Response

Status code:: 200

{
  "status": "running",
  "lastResult": {
    "status": "success",
    "errorMessage": null,
    "startTime": "2014-11-26T03:37:18.853Z",
    "endTime": "2014-11-26T03:37:19.012Z",
    "errors": [],
    "warnings": [],
    "itemsProcessed": 11,
    "itemsFailed": 0,
    "initialTrackingState": null,
    "finalTrackingState": null
  },
  "executionHistory": [
    {
      "status": "success",
      "errorMessage": null,
      "startTime": "2014-11-26T03:37:18.853Z",
      "endTime": "2014-11-26T03:37:19.012Z",
      "errors": [],
      "warnings": [],
      "itemsProcessed": 11,
      "itemsFailed": 0,
      "initialTrackingState": null,
      "finalTrackingState": null
    },
    {
      "status": "transientFailure",
      "errorMessage": null,
      "startTime": "2014-11-26T03:28:10.125Z",
      "endTime": "2014-11-26T03:28:12.007Z",
      "errors": [
        {
          "key": "",
          "errorMessage": "Document key cannot be missing or empty.",
          "statusCode": 400,
          "name": null,
          "details": null,
          "documentationLink": null
        },
        {
          "key": "document id 1",
          "errorMessage": "Could not read the value of column 'foo' at index '0'.",
          "statusCode": 400,
          "name": "DocumentExtraction.AzureBlob.MyDataSource",
          "details": "The file could not be parsed.",
          "documentationLink": "https://go.microsoft.com/fwlink/?linkid=2049388"
        }
      ],
      "warnings": [
        {
          "key": "document id",
          "message": "A warning doesn't stop indexing, and is intended to inform you of certain interesting situations, like when a blob indexer truncates the amount of text extracted from a blob.",
          "name": null,
          "details": null,
          "documentationLink": null
        },
        {
          "key": "document id 2",
          "message": "Document was truncated to 50000 characters.",
          "name": "Enrichment.LanguageDetectionSkill.#4",
          "details": "The skill did something that didn't break anything, nonetheless something we didn't expect happened, so it might be worth double checking.",
          "documentationLink": "https://go.microsoft.com/fwlink/?linkid=2099692"
        }
      ],
      "itemsProcessed": 1,
      "itemsFailed": 2,
      "initialTrackingState": null,
      "finalTrackingState": null
    }
  ],
  "limits": {
    "maxRunTime": "PT22H",
    "maxDocumentExtractionSize": 256000000,
    "maxDocumentContentCharactersToExtract": 4000000
  }
}

Definitions

Name	Description
IndexerCurrentState	Represents all of the state that defines and dictates the indexer's current execution.
IndexerExecutionResult	Represents the result of an individual indexer execution.
IndexerExecutionStatus	Represents the status of an individual indexer execution.
IndexerExecutionStatusDetail	Details the status of an individual indexer execution.
IndexerStatus	Represents the overall indexer status.
IndexingMode	Represents the mode the indexer is executing in.
SearchError	Describes an error condition for the API.
SearchIndexerError	Represents an item- or document-level indexing error.
SearchIndexerLimits
SearchIndexerStatus	Represents the current status and execution history of an indexer.
SearchIndexerWarning	Represents an item-level warning.

IndexerCurrentState

Represents all of the state that defines and dictates the indexer's current execution.

Name	Type	Description
allDocsFinalChangeTrackingState	string	Change tracking state value when indexing finishes on all documents in the datasource.
allDocsInitialChangeTrackingState	string	Change tracking state used when indexing starts on all documents in the datasource.
mode	IndexingMode	The mode the indexer is running in.
resetDatasourceDocumentIds	string[]	The list of datasource document ids that have been reset. The datasource document id is the unique identifier for the data in the datasource. The indexer will prioritize selectively re-ingesting these ids.
resetDocsFinalChangeTrackingState	string	Change tracking state value when indexing finishes on select, reset documents in the datasource.
resetDocsInitialChangeTrackingState	string	Change tracking state used when indexing starts on select, reset documents in the datasource.
resetDocumentKeys	string[]	The list of document keys that have been reset. The document key is the document's unique identifier for the data in the search index. The indexer will prioritize selectively re-ingesting these keys.

IndexerExecutionResult

Represents the result of an individual indexer execution.

Name	Type	Description
currentState	IndexerCurrentState	All of the state that defines and dictates the indexer's current execution.
endTime	string	The end time of this indexer execution, if the execution has already completed.
errorMessage	string	The error message indicating the top-level error, if any.
errors	SearchIndexerError[]	The item-level indexing errors.
finalTrackingState	string	Change tracking state with which an indexer execution finished.
initialTrackingState	string	Change tracking state with which an indexer execution started.
itemsFailed	integer	The number of items that failed to be indexed during this indexer execution.
itemsProcessed	integer	The number of items that were processed during this indexer execution. This includes both successfully processed items and items where indexing was attempted but failed.
startTime	string	The start time of this indexer execution.
status	IndexerExecutionStatus	The outcome of this indexer execution.
statusDetail	IndexerExecutionStatusDetail	The outcome of this indexer execution.
warnings	SearchIndexerWarning[]	The item-level indexing warnings.

IndexerExecutionStatus

Represents the status of an individual indexer execution.

Name	Type	Description
inProgress	string	Indexer execution is in progress.
reset	string	Indexer has been reset.
success	string	Indexer execution completed successfully.
transientFailure	string	An indexer invocation has failed, but the failure may be transient. Indexer invocations will continue per schedule.

IndexerExecutionStatusDetail

Details the status of an individual indexer execution.

Name	Type	Description
resetDocs	string	Indicates that the reset that occurred was for a call to ResetDocs.

IndexerStatus

Represents the overall indexer status.

Name	Type	Description
error	string	Indicates that the indexer experienced an error that cannot be corrected without human intervention.
running	string	Indicates that the indexer is running normally.
unknown	string	Indicates that the indexer is in an unknown state.

IndexingMode

Represents the mode the indexer is executing in.

Name	Type	Description
indexingAllDocs	string	The indexer is indexing all documents in the datasource.
indexingResetDocs	string	The indexer is indexing selective, reset documents in the datasource. The documents being indexed are defined on indexer status.

SearchError

Describes an error condition for the API.

Name	Type	Description
code	string	One of a server-defined set of error codes.
details	SearchError[]	An array of details about specific errors that led to this reported error.
message	string	A human-readable representation of the error.

SearchIndexerError

Represents an item- or document-level indexing error.

Name	Type	Description
details	string	Additional, verbose details about the error to assist in debugging the indexer. This may not be always available.
documentationLink	string	A link to a troubleshooting guide for these classes of errors. This may not be always available.
errorMessage	string	The message describing the error that occurred while processing the item.
key	string	The key of the item for which indexing failed.
name	string	The name of the source at which the error originated. For example, this could refer to a particular skill in the attached skillset. This may not be always available.
statusCode	integer	The status code indicating why the indexing operation failed. Possible values include: 400 for a malformed input document, 404 for document not found, 409 for a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy.

SearchIndexerLimits

Name	Type	Description
maxDocumentContentCharactersToExtract	number	The maximum number of characters that will be extracted from a document picked up for indexing.
maxDocumentExtractionSize	number	The maximum size of a document, in bytes, which will be considered valid for indexing.
maxRunTime	string	The maximum duration that the indexer is permitted to run for one execution.

SearchIndexerStatus

Represents the current status and execution history of an indexer.

Name	Type	Description
executionHistory	IndexerExecutionResult[]	History of the recent indexer executions, sorted in reverse chronological order.
lastResult	IndexerExecutionResult	The result of the most recent or an in-progress indexer execution.
limits	SearchIndexerLimits	The execution limits for the indexer.
status	IndexerStatus	Overall indexer status.

SearchIndexerWarning

Represents an item-level warning.

Name	Type	Description
details	string	Additional, verbose details about the warning to assist in debugging the indexer. This may not be always available.
documentationLink	string	A link to a troubleshooting guide for these classes of warnings. This may not be always available.
key	string	The key of the item which generated a warning.
message	string	The message describing the warning that occurred while processing the item.
name	string	The name of the source at which the warning originated. For example, this could refer to a particular skill in the attached skillset. This may not be always available.