Indexers - Get Status

Tjänst:: Search Service

API-version:: 2025-11-01-preview

Returnerar aktuell status och körningshistorik för en indexerare.

GET {endpoint}/indexers('{indexerName}')/search.status?api-version=2025-11-01-preview

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string (uri)	Slutpunkts-URL:en för söktjänsten.
indexerName	path	True	string	Namnet på indexeraren.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-request-id		string (uuid)	En ogenomskinlig, globalt unik, klientgenererad strängidentifierare för begäran.
Accept		Accept	Acceptera-rubriken.

Svar

Name	Typ	Description
200 OK	SearchIndexerStatus	Begäran har slutförts.
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

api-key

Typ: apiKey
I: header

OAuth2Auth

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Omfattningar

Name	Description
https://search.azure.com/.default

Exempel

SearchServiceGetIndexerStatus

SearchServiceGetS3HDUnlimitedIndexerStatus

SearchServiceGetIndexerStatus

Exempelbegäran

HTTP

GET https://previewexampleservice.search.windows.net/indexers('myindexer')/search.status?api-version=2025-11-01-preview

Exempelsvar

Statuskod:: 200

{
  "name": "myindexer",
  "status": "running",
  "runtime": {
    "usedSeconds": 0,
    "beginningTime": "2024-06-06T00:00:00.000Z",
    "endingTime": "2024-06-07T00:00:00.000Z"
  },
  "lastResult": {
    "status": "success",
    "startTime": "2014-11-26T03:37:18.853Z",
    "endTime": "2014-11-26T03:37:19.012Z",
    "itemsProcessed": 11,
    "itemsFailed": 0,
    "mode": "indexingAllDocs",
    "errors": [],
    "warnings": []
  },
  "executionHistory": [
    {
      "status": "success",
      "startTime": "2014-11-26T03:37:18.853Z",
      "endTime": "2014-11-26T03:37:19.012Z",
      "itemsProcessed": 11,
      "itemsFailed": 0,
      "mode": "indexingAllDocs",
      "errors": [],
      "warnings": []
    },
    {
      "status": "transientFailure",
      "startTime": "2014-11-26T03:28:10.125Z",
      "endTime": "2014-11-26T03:28:12.007Z",
      "itemsProcessed": 1,
      "itemsFailed": 2,
      "mode": "indexingAllDocs",
      "errors": [
        {
          "key": "",
          "statusCode": 400,
          "errorMessage": "Document key cannot be missing or empty."
        },
        {
          "key": "document id 1",
          "statusCode": 400,
          "name": "DocumentExtraction.AzureBlob.MyDataSource",
          "errorMessage": "Could not read the value of column 'foo' at index '0'.",
          "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."
        },
        {
          "key": "document id 2",
          "name": "Enrichment.LanguageDetectionSkill.#4",
          "message": "Document was truncated to 50000 characters.",
          "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"
        }
      ]
    }
  ],
  "limits": {
    "maxRunTime": "PT22H",
    "maxDocumentExtractionSize": 256000000,
    "maxDocumentContentCharactersToExtract": 4000000
  },
  "currentState": {
    "mode": "indexingAllDocs",
    "resetDocumentKeys": [],
    "resetDatasourceDocumentIds": []
  }
}

SearchServiceGetS3HDUnlimitedIndexerStatus

Exempelbegäran

HTTP

GET https://previewexampleservice.search.windows.net/indexers('myindexer')/search.status?api-version=2025-11-01-preview

Exempelsvar

Statuskod:: 200

{
  "name": "myindexer",
  "status": "running",
  "runtime": {
    "usedSeconds": 0,
    "remainingSeconds": 39600,
    "beginningTime": "2024-06-06T00:00:00.000Z",
    "endingTime": "2024-06-07T00:00:00.000Z"
  },
  "lastResult": {
    "status": "success",
    "startTime": "2014-11-26T03:37:18.853Z",
    "endTime": "2014-11-26T03:37:19.012Z",
    "itemsProcessed": 11,
    "itemsFailed": 0,
    "mode": "indexingAllDocs",
    "errors": [],
    "warnings": []
  },
  "executionHistory": [
    {
      "status": "success",
      "startTime": "2014-11-26T03:37:18.853Z",
      "endTime": "2014-11-26T03:37:19.012Z",
      "itemsProcessed": 11,
      "itemsFailed": 0,
      "mode": "indexingAllDocs",
      "errors": [],
      "warnings": []
    },
    {
      "status": "transientFailure",
      "startTime": "2014-11-26T03:28:10.125Z",
      "endTime": "2014-11-26T03:28:12.007Z",
      "itemsProcessed": 1,
      "itemsFailed": 2,
      "mode": "indexingAllDocs",
      "errors": [
        {
          "key": "",
          "statusCode": 400,
          "errorMessage": "Document key cannot be missing or empty."
        },
        {
          "key": "document id 1",
          "statusCode": 400,
          "name": "DocumentExtraction.AzureBlob.MyDataSource",
          "errorMessage": "Could not read the value of column 'foo' at index '0'.",
          "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."
        },
        {
          "key": "document id 2",
          "name": "Enrichment.LanguageDetectionSkill.#4",
          "message": "Document was truncated to 50000 characters.",
          "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"
        }
      ]
    }
  ],
  "limits": {
    "maxRunTime": "PT22H",
    "maxDocumentExtractionSize": 256000000,
    "maxDocumentContentCharactersToExtract": 4000000
  },
  "currentState": {
    "mode": "indexingAllDocs",
    "resetDocumentKeys": [],
    "resetDatasourceDocumentIds": []
  }
}

Definitioner

Name	Description
Accept	Acceptera-rubriken.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).
IndexerCurrentState	Representerar allt tillstånd som definierar och dikterar indexerarens aktuella körning.
IndexerExecutionResult	Representerar resultatet av en enskild indexerarekörning.
IndexerExecutionStatus	Representerar statusen för en enskild indexerarkörning.
IndexerExecutionStatusDetail	Beskriver status för en enskild indexerarkörning.
IndexerRuntime	Representerar indexerarens kumulativa körningsförbrukning i tjänsten.
IndexerStatus	Representerar den övergripande indexerarstatusen.
IndexingMode	Representerar det läge som indexeraren körs i.
SearchIndexerError	Representerar ett indexeringsfel på objekt- eller dokumentnivå.
SearchIndexerLimits	Representerar de gränser som kan tillämpas på en indexerare.
SearchIndexerStatus	Representerar den aktuella statusen och körningshistoriken för en indexerare.
SearchIndexerWarning	Representerar en varning på objektnivå.

Accept

Uppräkning

Acceptera-rubriken.

Värde	Description
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info		Den ytterligare informationen.
type	string	Typen av ytterligare information.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Felet ytterligare information.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felet riktas.

ErrorResponse

Objekt

Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).

Name	Typ	Description
error	ErrorDetail	Felet objektet.

IndexerCurrentState

Objekt

Representerar allt tillstånd som definierar och dikterar indexerarens aktuella körning.

Name	Typ	Description
allDocsFinalTrackingState	string	Ändra statusvärdet för spårning när indexeringen slutförs på alla dokument i datakällan.
allDocsInitialTrackingState	string	Ändringsspårningstillstånd som används när indexeringen startar på alla dokument i datakällan.
mode	IndexingMode	Läget som indexeraren körs i.
resetDatasourceDocumentIds	string[]	Listan över dokument-ID:t för datakällor som har återställts. Dokument-ID:t för datakällan är den unika identifieraren för data i datakällan. Indexeraren prioriterar selektiv återmatning av dessa ID:er.
resetDocsFinalTrackingState	string	Ändra värdet för spårningstillstånd när indexeringen är klar när du väljer återställer du dokument i datakällan.
resetDocsInitialTrackingState	string	Ändringsspårningstillstånd som används när indexeringen börjar vid select återställer dokument i datakällan.
resetDocumentKeys	string[]	Listan över dokumentnycklar som har återställts. Dokumentnyckeln är dokumentets unika identifierare för data i sökindexet. Indexeraren prioriterar selektiv återmatning av dessa nycklar.
resyncFinalTrackingState	string	Ändra värdet för spårningstillstånd när indexeringen är klar för selektiva alternativ från datakällan.
resyncInitialTrackingState	string	Ändra spårningstillstånd som används när indexeringen startar på selektiva alternativ från datakällan.

IndexerExecutionResult

Objekt

Representerar resultatet av en enskild indexerarekörning.

Name	Typ	Description
endTime	string (date-time)	Sluttiden för den här indexerarens körning, om körningen redan har slutförts.
errorMessage	string	Felmeddelandet som anger felet på den översta nivån, om det finns något.
errors	SearchIndexerError[]	Indexeringsfel på objektnivå.
finalTrackingState	string	Ändra spårningstillståndet som en indexerares körning har slutförts med.
initialTrackingState	string	Ändringsspårningstillstånd som en indexerares körning startades med.
itemsFailed	integer (int32)	Antalet objekt som inte kunde indexeras under den här indexeringskörningen.
itemsProcessed	integer (int32)	Antalet objekt som bearbetades under den här indexeringskörningen. Detta omfattar både objekt som bearbetats korrekt och objekt där indexering försöktes men misslyckades.
mode	IndexingMode	Läget som indexeraren körs i.
startTime	string (date-time)	Starttiden för den här indexerarens körning.
status	IndexerExecutionStatus	Resultatet av den här indexeringskörningen.
statusDetail	IndexerExecutionStatusDetail	Resultatet av den här indexeringskörningen.
warnings	SearchIndexerWarning[]	Indexeringsvarningarna på objektnivå.

IndexerExecutionStatus

Uppräkning

Representerar statusen för en enskild indexerarkörning.

Värde	Description
transientFailure	Ett indexeraranrop har misslyckats, men felet kan vara tillfälligt. Indexeraranrop fortsätter enligt schema.
success	Indexerarens körning har slutförts.
inProgress	Indexerarens körning pågår.
reset	Indexeraren har återställts.

IndexerExecutionStatusDetail

Uppräkning

Beskriver status för en enskild indexerarkörning.

Värde	Description
resetDocs	Anger att återställningen som inträffade var för ett anrop till ResetDocs.
resync	Indikerar att selektivt synkronisera om baserat på alternativ från datakällan.

IndexerRuntime

Objekt

Representerar indexerarens kumulativa körningsförbrukning i tjänsten.

Name	Typ	Description
beginningTime	string (date-time)	Inledande UTC-tid för den 24-timmarsperiod som beaktas för indexerarens körningsanvändning (inklusive).
endingTime	string (date-time)	Slut UTC-tid för den 24-timmarsperiod som beaktas för indexerarens körningsanvändning (inklusive).
remainingSeconds	integer (int64)	Kumulativ körning återstår för alla indexerare i tjänsten från beginningTime till endingTime, i sekunder.
usedSeconds	integer (int64)	Kumulativ körning av indexeraren från beginningTime till endingTime, i sekunder.

IndexerStatus

Uppräkning

Representerar den övergripande indexerarstatusen.

Värde	Description
unknown	Anger att indexeraren är i ett okänt tillstånd.
error	Anger att indexeraren har drabbats av ett fel som inte kan korrigeras utan mänsklig inblandning.
running	Anger att indexeraren körs normalt.

IndexingMode

Uppräkning

Representerar det läge som indexeraren körs i.

Värde	Description
indexingAllDocs	Indexeraren indexerar alla dokument i datakällan.
indexingResetDocs	Indexeraren indexerar selektiva och återställer dokument i datakällan. De dokument som indexeras definieras efter indexerarens status.
indexingResync	Indexeraren synkroniserar om och indexerar selektiva alternativ från datakällan.

SearchIndexerError

Objekt

Representerar ett indexeringsfel på objekt- eller dokumentnivå.

Name	Typ	Description
details	string	Ytterligare, utförlig information om felet för att hjälpa till att felsöka indexeraren. Detta kanske inte alltid är tillgängligt.
documentationLink	string	En länk till en felsökningsguide för dessa felklasser. Detta kanske inte alltid är tillgängligt.
errorMessage	string	Meddelandet som beskriver felet som uppstod när objektet bearbetades.
key	string	Nyckeln för det objekt som indexeringen misslyckades för.
name	string	Namnet på källan som felet kom från. Detta kan till exempel referera till en viss färdighet i den kopplade kompetensuppsättningen. Detta kanske inte alltid är tillgängligt.
statusCode	integer (int32)	Statuskoden som anger varför indexeringsåtgärden misslyckades. Möjliga värden är: 400 för ett felaktigt utformat indatadokument, 404 för dokumentet hittades inte, 409 för en versionskonflikt, 422 när indexet är tillfälligt otillgängligt eller 503 för när tjänsten är för upptagen.

SearchIndexerLimits

Objekt

Representerar de gränser som kan tillämpas på en indexerare.

Name	Typ	Description
maxDocumentContentCharactersToExtract	integer (int64)	Det maximala antalet tecken som ska extraheras från ett dokument som hämtas för indexering.
maxDocumentExtractionSize	integer (int64)	Den maximala storleken på ett dokument, i byte, som anses vara giltigt för indexering.
maxRunTime	string (duration)	Den maximala varaktighet som indexeraren får köra för en körning.

SearchIndexerStatus

Objekt

Representerar den aktuella statusen och körningshistoriken för en indexerare.

Name	Typ	Description
currentState	IndexerCurrentState	Allt tillstånd som definierar och dikterar indexerarens aktuella körning.
executionHistory	IndexerExecutionResult[]	Historik över de senaste indexeringskörningarna, sorterade i omvänd kronologisk ordning.
lastResult	IndexerExecutionResult	Resultatet av den senaste eller pågående indexeringskörningen.
limits	SearchIndexerLimits	Körningsgränserna för indexeraren.
name	string	Namnet på indexeraren.
runtime	IndexerRuntime	Ögonblicksbild av indexerarens kumulativa körtidsanvändning för tjänsten under den aktuella UTC-perioden.
status	IndexerStatus	Övergripande indexerarstatus.

SearchIndexerWarning

Objekt

Representerar en varning på objektnivå.

Name	Typ	Description
details	string	Ytterligare, utförlig information om varningen för att hjälpa till att felsöka indexeraren. Detta kanske inte alltid är tillgängligt.
documentationLink	string	En länk till en felsökningsguide för dessa klasser av varningar. Detta kanske inte alltid är tillgängligt.
key	string	Nyckeln för det objekt som genererade en varning.
message	string	Meddelandet som beskriver varningen som uppstod när objektet bearbetades.
name	string	Namnet på den källa som varningen kommer från. Detta kan till exempel referera till en viss färdighet i den kopplade kompetensuppsättningen. Detta kanske inte alltid är tillgängligt.