Indexers - Get Status

Referens

Tjänst:: Search Service

API-version:: 2024-07-01

Returnerar den aktuella status- och körningshistoriken för en indexerare.

GET {endpoint}/indexers('{indexerName}')/search.status?api-version=2024-07-01

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	Slutpunkts-URL:en för söktjänsten.
indexerName	path	True	string	Namnet på indexeraren som statusen ska hämtas för.
api-version	query	True	string	Klient-API-version.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-request-id		string uuid	Spårnings-ID:t som skickas med begäran för att hjälpa till med felsökning.

Svar

Name	Typ	Description
200 OK	SearchIndexerStatus
Other Status Codes	ErrorResponse	Felsvar.

Exempel

SearchServiceGetIndexerStatus

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 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
  }
}

Definitioner

Name	Description
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
IndexerExecutionResult	Representerar resultatet av en enskild indexerarekörning.
IndexerExecutionStatus	Representerar statusen för en enskild indexerarekörning.
IndexerStatus	Representerar den övergripande indexerarens status.
SearchIndexerError	Representerar ett indexeringsfel på objekt- eller dokumentnivå.
SearchIndexerLimits
SearchIndexerStatus	Representerar den aktuella statusen och körningshistoriken för en indexerare.
SearchIndexerWarning	Representerar en varning på objektnivå.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

IndexerExecutionResult

Representerar resultatet av en enskild indexerarekörning.

Name	Typ	Description
endTime	string	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	Antalet objekt som inte kunde indexeras under den här indexeringskörningen.
itemsProcessed	integer	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.
startTime	string	Starttiden för den här indexerarens körning.
status	IndexerExecutionStatus	Resultatet av den här indexeringskörningen.
warnings	SearchIndexerWarning[]	Indexeringsvarningarna på objektnivå.

IndexerExecutionStatus

Representerar statusen för en enskild indexerarekörning.

Name	Typ	Description
inProgress	string	Indexerarens körning pågår.
reset	string	Indexeraren har återställts.
success	string	Indexerarens körning har slutförts.
transientFailure	string	Det gick inte att anropa indexeraren, men felet kan vara tillfälligt. Indexerarens anrop fortsätter enligt schema.

IndexerStatus

Representerar den övergripande indexerarens status.

Name	Typ	Description
error	string	Anger att indexeraren har upplevt ett fel som inte kan korrigeras utan mänsklig inblandning.
running	string	Anger att indexeraren körs normalt.
unknown	string	Anger att indexeraren är i ett okänt tillstånd.

SearchIndexerError

Representerar ett indexeringsfel på objekt- eller dokumentnivå.

Name	Typ	Description
details	string	Dessutom utförlig information om felet som hjälper dig 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 där felet uppstod. Detta kan till exempel referera till en viss färdighet i den bifogade kompetensuppsättningen. Detta kanske inte alltid är tillgängligt.
statusCode	integer	Statuskoden som anger varför indexeringsåtgärden misslyckades. Möjliga värden är: 400 för ett felaktigt 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

Name	Typ	Description
maxDocumentContentCharactersToExtract	number	Det maximala antalet tecken som ska extraheras från ett dokument som hämtats för indexering.
maxDocumentExtractionSize	number	Den maximala storleken på ett dokument, i byte, som anses vara giltig för indexering.
maxRunTime	string	Den maximala varaktighet som indexeraren tillåts köra för en körning.

SearchIndexerStatus

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

Name	Typ	Description
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.
status	IndexerStatus	Övergripande indexerarstatus.

SearchIndexerWarning

Representerar en varning på objektnivå.

Name	Typ	Description
details	string	Dessutom utförlig information om varningen som hjälper dig att felsöka indexeraren. Detta kanske inte alltid är tillgängligt.
documentationLink	string	En länk till en felsökningsguide för dessa varningsklasser. Detta kanske inte alltid är tillgängligt.
key	string	Nyckeln för objektet som genererade en varning.
message	string	Meddelandet som beskriver varningen som inträffade när objektet bearbetades.
name	string	Namnet på källan som varningen kom från. Detta kan till exempel referera till en viss färdighet i den bifogade kompetensuppsättningen. Detta kanske inte alltid är tillgängligt.

Dela via