Indexers - Get Status

Service:: Search Service

API-versie:: 2024-05-01-preview

Retourneert de huidige status en uitvoeringsgeschiedenis van een indexeerfunctie.

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

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 tracerings-id die is verzonden met de aanvraag om hulp te bieden bij foutopsporing.

Antwoorden

Name	Type	Description
200 OK	SearchIndexerStatus
Other Status Codes	ErrorResponse	Foutreactie.

Voorbeelden

SearchServiceGetIndexerStatus

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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

Definities

Name	Description
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
IndexerCurrentState	Vertegenwoordigt alle statussen die de huidige uitvoering van de indexeerfunctie definiëren en dicteren.
IndexerExecutionResult	Vertegenwoordigt het resultaat van de uitvoering van een afzonderlijke indexeerfunctie.
IndexerExecutionStatus	Vertegenwoordigt de status van de uitvoering van een afzonderlijke indexeerfunctie.
IndexerExecutionStatusDetail	Details van de status van de uitvoering van een afzonderlijke indexeerfunctie.
IndexerStatus	Vertegenwoordigt de algehele status van de indexeerfunctie.
IndexingMode	Vertegenwoordigt de modus waarin de indexeerfunctie wordt uitgevoerd.
SearchIndexerError	Vertegenwoordigt een indexeringsfout op item- of documentniveau.
SearchIndexerLimits
SearchIndexerStatus	Vertegenwoordigt de huidige status en uitvoeringsgeschiedenis van een indexeerfunctie.
SearchIndexerWarning	Vertegenwoordigt een waarschuwing op itemniveau.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

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

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

IndexerCurrentState

Object

Vertegenwoordigt alle statussen die de huidige uitvoering van de indexeerfunctie definiëren en dicteren.

Name	Type	Description
allDocsFinalChangeTrackingState	string	Statuswaarde voor wijzigingen bijhouden wanneer indexering is voltooid voor alle documenten in de gegevensbron.
allDocsInitialChangeTrackingState	string	Status van wijzigingen bijhouden die wordt gebruikt bij het indexeren van alle documenten in de gegevensbron.
mode	IndexingMode	De modus waarin de indexeerfunctie wordt uitgevoerd.
resetDatasourceDocumentIds	string[]	De lijst met gegevensbrondocument-id's die opnieuw zijn ingesteld. De document-id van de gegevensbron is de unieke id voor de gegevens in de gegevensbron. De indexeerfunctie geeft prioriteit aan het selectief opnieuw opnemen van deze id's.
resetDocsFinalChangeTrackingState	string	Wijzigingsstatuswaarde bijhouden wanneer indexering is voltooid bij selecteren, documenten opnieuw instellen in de gegevensbron.
resetDocsInitialChangeTrackingState	string	Status van wijzigingen bijhouden die wordt gebruikt bij het indexeren bij selecteren, documenten opnieuw instellen in de gegevensbron.
resetDocumentKeys	string[]	De lijst met documentsleutels die opnieuw zijn ingesteld. De documentsleutel is de unieke id van het document voor de gegevens in de zoekindex. De indexeerfunctie geeft prioriteit aan selectief opnieuw opnemen van deze sleutels.

IndexerExecutionResult

Object

Vertegenwoordigt het resultaat van de uitvoering van een afzonderlijke indexeerfunctie.

Name	Type	Description
currentState	IndexerCurrentState	Alle statussen die de huidige uitvoering van de indexeerfunctie definiëren en dicteren.
endTime	string (date-time)	De eindtijd van de uitvoering van deze indexeerfunctie, als de uitvoering al is voltooid.
errorMessage	string	Het foutbericht dat de fout op het hoogste niveau aangeeft, indien van toepassing.
errors	SearchIndexerError[]	De indexeringsfouten op itemniveau.
finalTrackingState	string	Status van wijzigingen bijhouden waarmee de uitvoering van een indexeerfunctie is voltooid.
initialTrackingState	string	Status van wijzigingen bijhouden waarmee de uitvoering van een indexeerfunctie is gestart.
itemsFailed	integer (int32)	Het aantal items dat niet kan worden 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 verwerkte items als items waarvoor indexering is geprobeerd, maar mislukt.
startTime	string (date-time)	De begintijd van de uitvoering van deze indexeerfunctie.
status	IndexerExecutionStatus	Het resultaat van de uitvoering van deze indexeerfunctie.
statusDetail	IndexerExecutionStatusDetail	Het resultaat van de uitvoering van deze indexeerfunctie.
warnings	SearchIndexerWarning[]	De indexeringswaarschuwingen op itemniveau.

IndexerExecutionStatus

Inventarisatie

Vertegenwoordigt de status van de uitvoering van een afzonderlijke indexeerfunctie.

Waarde	Description
transientFailure	Een aanroep van een indexeerfunctie is mislukt, maar de fout kan tijdelijk zijn. Aanroepen van de indexeerfunctie worden volgens schema voortgezet.
success	De uitvoering van de indexeerfunctie is voltooid.
inProgress	De uitvoering van de indexeerfunctie wordt uitgevoerd.
reset	De indexeerfunctie is opnieuw ingesteld.

IndexerExecutionStatusDetail

Inventarisatie

Details van de status van de uitvoering van een afzonderlijke indexeerfunctie.

Waarde	Description
resetDocs	Geeft aan dat de reset die is opgetreden, was voor een aanroep naar ResetDocs.

IndexerStatus

Inventarisatie

Vertegenwoordigt de algehele status van de indexeerfunctie.

Waarde	Description
unknown	Geeft aan dat de indexeerfunctie een onbekende status heeft.
error	Geeft aan dat de indexeerfunctie een fout heeft ondervonden die niet kan worden gecorrigeerd zonder menselijke tussenkomst.
running	Geeft aan dat de indexeerfunctie normaal wordt uitgevoerd.

IndexingMode

Inventarisatie

Vertegenwoordigt de modus waarin de indexeerfunctie wordt uitgevoerd.

Waarde	Description
indexingAllDocs	De indexeerfunctie indexeert alle documenten in de gegevensbron.
indexingResetDocs	De indexeerfunctie indexeert selectief en stelt documenten opnieuw in de gegevensbron in. De documenten die worden geïndexeerd, worden gedefinieerd in de status van de indexeerfunctie.

SearchIndexerError

Object

Vertegenwoordigt een indexeringsfout op item- of documentniveau.

Name	Type	Description
details	string	Aanvullende uitgebreide informatie 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 gids voor probleemoplossing voor deze foutenklassen. Dit is mogelijk niet altijd beschikbaar.
errorMessage	string	Het bericht met een beschrijving van de fout die is opgetreden tijdens het verwerken van het item.
key	string	De sleutel van het item waarvoor indexering is mislukt.
name	string	De naam van de bron waar de fout vandaan komt. Dit kan bijvoorbeeld verwijzen naar een bepaalde vaardigheid in de gekoppelde 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 ongeldig 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

Object

Name	Type	Description
maxDocumentContentCharactersToExtract	number (int64)	Het maximum 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

Object

Vertegenwoordigt de huidige status en uitvoeringsgeschiedenis van een indexeerfunctie.

Name	Type	Description
executionHistory	IndexerExecutionResult[]	Geschiedenis van de recente uitvoeringen van de indexeerfunctie, gesorteerd in omgekeerde chronologische volgorde.
lastResult	IndexerExecutionResult	Het resultaat van de meest recente uitvoering of een actieve indexeerfunctie.
limits	SearchIndexerLimits	De uitvoeringslimieten voor de indexeerfunctie.
status	IndexerStatus	Algemene status van de indexeerfunctie.

SearchIndexerWarning

Object

Vertegenwoordigt een waarschuwing op itemniveau.

Name	Type	Description
details	string	Aanvullende uitgebreide informatie over de waarschuwing om te helpen bij het opsporen van fouten in de indexeerfunctie. Dit is mogelijk niet altijd beschikbaar.
documentationLink	string	Een koppeling naar een gids voor probleemoplossing voor deze klassen waarschuwingen. Dit is mogelijk niet altijd beschikbaar.
key	string	De sleutel van het item dat een waarschuwing heeft gegenereerd.
message	string	Het bericht met een beschrijving van de waarschuwing die is opgetreden tijdens het verwerken van het item.
name	string	De naam van de bron waarop de waarschuwing afkomstig is. Dit kan bijvoorbeeld verwijzen naar een bepaalde vaardigheid in de gekoppelde vaardighedenset. Dit is mogelijk niet altijd beschikbaar.

Delen via

Indexers - Get Status

URI-parameters

Aanvraagkoptekst

Antwoorden

Voorbeelden

SearchServiceGetIndexerStatus

Voorbeeldaanvraag

Voorbeeldrespons

Definities

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IndexerCurrentState

IndexerExecutionResult

IndexerExecutionStatus

IndexerExecutionStatusDetail

IndexerStatus

IndexingMode

SearchIndexerError

SearchIndexerLimits

SearchIndexerStatus

SearchIndexerWarning