Delen via


Indexers - Get Status

Berekent de huidige status en uitvoeringsgeschiedenis van een indexeerfunctie.

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

URI-parameters

Name In Vereist Type Description
endpoint
path True

string

De eindpunt-URL van de zoekservice.

indexerName
path True

string

De naam van de indexeerfunctie waarvoor de status moet worden opgehaald.

api-version
query True

string

Client-API-versie.

Aanvraagkoptekst

Name Vereist Type Description
x-ms-client-request-id

string (uuid)

De tracking-ID die is verzonden met het verzoek om te helpen bij het opsporen.

Antwoorden

Name Type Description
200 OK

SearchIndexerStatus

Other Status Codes

ErrorResponse

Foutreactie.

Voorbeelden

SearchServiceGetIndexerStatus

Voorbeeldaanvraag

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

Voorbeeldrespons

{
  "name": "myindexer",
  "status": "running",
  "lastResult": {
    "status": "success",
    "startTime": "2014-11-26T03:37:18.853Z",
    "endTime": "2014-11-26T03:37:19.012Z",
    "itemsProcessed": 11,
    "itemsFailed": 0,
    "errors": [],
    "warnings": []
  },
  "executionHistory": [
    {
      "status": "success",
      "startTime": "2014-11-26T03:37:18.853Z",
      "endTime": "2014-11-26T03:37:19.012Z",
      "itemsProcessed": 11,
      "itemsFailed": 0,
      "errors": [],
      "warnings": []
    },
    {
      "status": "transientFailure",
      "startTime": "2014-11-26T03:28:10.125Z",
      "endTime": "2014-11-26T03:28:12.007Z",
      "itemsProcessed": 1,
      "itemsFailed": 2,
      "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
  }
}

Definities

Name Description
ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

ErrorDetail

De foutdetails.

ErrorResponse

Foutreactie

IndexerExecutionResult

Vertegenwoordigt het resultaat van een afzonderlijke uitvoering van een indexeerfunctie.

IndexerExecutionStatus

Vertegenwoordigt de status van een afzonderlijke uitvoering van een indexeerfunctie.

IndexerStatus

Vertegenwoordigt de algemene status van de indexeerfunctie.

SearchIndexerError

Vertegenwoordigt een indexeringsfout op item- of documentniveau.

SearchIndexerLimits
SearchIndexerStatus

Vertegenwoordigt de huidige status en uitvoeringsgeschiedenis van een indexeerfunctie.

SearchIndexerWarning

Vertegenwoordigt een waarschuwing op artikelniveau.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

object

De aanvullende informatie.

type

string

Het extra informatietype.

ErrorDetail

De foutdetails.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

De fout bevat aanvullende informatie.

code

string

De foutcode.

details

ErrorDetail[]

De foutdetails.

message

string

Het foutbericht.

target

string

Het foutdoel.

ErrorResponse

Foutreactie

Name Type Description
error

ErrorDetail

Het foutobject.

IndexerExecutionResult

Vertegenwoordigt het resultaat van een afzonderlijke uitvoering van een indexeerfunctie.

Name Type Description
endTime

string (date-time)

De eindtijd van deze uitvoering van de indexeerfunctie, als de uitvoering al is voltooid.

errorMessage

string

Het foutbericht dat de eventuele fout op het hoogste niveau aangeeft.

errors

SearchIndexerError[]

De indexeringsfouten op artikelniveau.

finalTrackingState

string

De status voor het bijhouden van wijzigingen waarmee een uitvoering van een indexeerfunctie is voltooid.

initialTrackingState

string

Status voor het bijhouden van wijzigingen waarmee een indexeerfunctie is gestart.

itemsFailed

integer (int32)

Het aantal items dat niet is geïndexeerd tijdens de uitvoering van deze indexeerfunctie.

itemsProcessed

integer (int32)

Het aantal items dat is verwerkt tijdens de uitvoering van deze indexeerfunctie. Dit omvat zowel succesvol verwerkte items als items waarvan is geprobeerd te indexeren maar dit is mislukt.

startTime

string (date-time)

De begintijd van deze uitvoering van de indexeerfunctie.

status

IndexerExecutionStatus

Het resultaat van deze uitvoering van de indexeerfunctie.

warnings

SearchIndexerWarning[]

De waarschuwingen voor indexering op artikelniveau.

IndexerExecutionStatus

Vertegenwoordigt de status van een afzonderlijke uitvoering van een indexeerfunctie.

Waarde Description
transientFailure

Een aanroep van een indexeerfunctie is mislukt, maar de fout kan van voorbijgaande aard zijn. Het aanroepen van indexeerfuncties wordt volgens het schema voortgezet.

success

De uitvoering van de indexeerfunctie is voltooid.

inProgress

De uitvoering van de indexeerfunctie is aan de gang.

reset

Indexer is gereset.

IndexerStatus

Vertegenwoordigt de algemene status van de indexeerfunctie.

Waarde Description
unknown

Geeft aan dat de indexeerfunctie zich in een onbekende staat bevindt.

error

Geeft aan dat er bij de indexeerfunctie een fout is opgetreden die niet kan worden gecorrigeerd zonder menselijke tussenkomst.

running

Geeft aan dat de indexeerfunctie normaal wordt uitgevoerd.

SearchIndexerError

Vertegenwoordigt een indexeringsfout op item- of documentniveau.

Name Type Description
details

string

Aanvullende, uitgebreide details over de fout om te helpen bij het opsporen van fouten in de indexeerfunctie. Dit is mogelijk niet altijd beschikbaar.

documentationLink

string

Een koppeling naar een handleiding voor het oplossen van problemen met deze soorten fouten. Dit is mogelijk niet altijd beschikbaar.

errorMessage

string

Het bericht dat de fout beschrijft die is opgetreden tijdens het verwerken van het artikel.

key

string

De sleutel van het artikel waarvoor het indexeren is mislukt.

name

string

De naam van de bron waar de fout is ontstaan. Dit kan bijvoorbeeld verwijzen naar een bepaalde vaardigheid in de bijgevoegde vaardighedenset. Dit is mogelijk niet altijd beschikbaar.

statusCode

integer (int32)

De statuscode die aangeeft waarom de indexeringsbewerking is mislukt. Mogelijke waarden zijn: 400 voor een verkeerd ingedeeld invoerdocument, 404 voor document niet gevonden, 409 voor een versieconflict, 422 wanneer de index tijdelijk niet beschikbaar is of 503 voor wanneer de service te druk is.

SearchIndexerLimits

Name Type Description
maxDocumentContentCharactersToExtract

number (int64)

Het maximale aantal tekens dat wordt geëxtraheerd uit een document dat wordt opgehaald voor indexering.

maxDocumentExtractionSize

number (int64)

De maximale grootte van een document, in bytes, die als geldig wordt beschouwd voor indexering.

maxRunTime

string (duration)

De maximale duur die de indexeerfunctie mag uitvoeren voor één uitvoering.

SearchIndexerStatus

Vertegenwoordigt de huidige status en uitvoeringsgeschiedenis van een indexeerfunctie.

Name Type Description
executionHistory

IndexerExecutionResult[]

Geschiedenis van de recente executies van de indexeerders, gesorteerd in omgekeerde chronologische volgorde.

lastResult

IndexerExecutionResult

Het resultaat van de meest recente of een lopende uitvoering van de indexeerfunctie.

limits

SearchIndexerLimits

De uitvoeringslimieten voor de indexeerfunctie.

name

string

De naam van de indexeerder.

status

IndexerStatus

Algehele status van de indexeerder.

SearchIndexerWarning

Vertegenwoordigt een waarschuwing op artikelniveau.

Name Type Description
details

string

Aanvullende, uitgebreide details over de waarschuwing om te helpen bij het opsporen van fouten in de indexeerfunctie. Dit is mogelijk niet altijd beschikbaar.

documentationLink

string

Een link naar een handleiding voor het oplossen van problemen met deze soorten waarschuwingen. Dit is mogelijk niet altijd beschikbaar.

key

string

De sleutel van het item dat een waarschuwing heeft gegenereerd.

message

string

Het bericht dat de waarschuwing beschrijft die is opgetreden tijdens het verwerken van het item.

name

string

De naam van de bron waar de waarschuwing vandaan komt. Dit kan bijvoorbeeld verwijzen naar een bepaalde vaardigheid in de bijgevoegde vaardighedenset. Dit is mogelijk niet altijd beschikbaar.