Indexers - Get Status
Retourneert de huidige status en uitvoeringsgeschiedenis van een indexeerfunctie.
GET {endpoint}/indexers('{indexerName}')/search.status?api-version=2026-05-01-preview
URI-parameters
| Name | In | Vereist | Type | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
De eindpunt-URL van de zoekservice. |
|
indexer
|
path | True |
string |
De naam van de indexeerder. |
|
api-version
|
query | True |
string minLength: 1 |
De API-versie die voor deze bewerking moet worden gebruikt. |
Aanvraagkoptekst
| Name | Vereist | Type | Description |
|---|---|---|---|
| Accept |
De Accepteer kop. |
||
| x-ms-client-request-id |
string (uuid) |
Een ondoorzichtige, wereldwijd unieke, door de client gegenereerde tekenreeks-id voor de aanvraag. |
Antwoorden
| Name | Type | Description |
|---|---|---|
| 200 OK |
De aanvraag is voltooid. |
|
| Other Status Codes |
Een onverwachte foutreactie. |
Beveiliging
api-key
Type:
apiKey
In:
header
OAuth2Auth
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Bereiken
| Name | Description |
|---|---|
| https://search.azure.com/.default |
Voorbeelden
|
Search |
|
Search |
SearchServiceGetIndexerStatus
Voorbeeldaanvraag
GET https://previewexampleservice.search.windows.net/indexers('myindexer')/search.status?api-version=2026-05-01-preview
Voorbeeldrespons
{
"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
Voorbeeldaanvraag
GET https://previewexampleservice.search.windows.net/indexers('myindexer')/search.status?api-version=2026-05-01-preview
Voorbeeldrespons
{
"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": []
}
}
Definities
| Name | Description |
|---|---|
| Accept |
De Accepteer kop. |
|
Error |
Aanvullende informatie over de resourcebeheerfout. |
|
Error |
Het foutdetail. |
|
Error |
Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.) |
|
Indexer |
Vertegenwoordigt alle statussen die de huidige uitvoering van de indexeerfunctie definiëren en dicteren. |
|
Indexer |
Vertegenwoordigt het resultaat van de uitvoering van een afzonderlijke indexeerfunctie. |
|
Indexer |
Vertegenwoordigt de status van een afzonderlijke uitvoering van een indexeerfunctie. |
|
Indexer |
Geeft details over de status van de uitvoering van een afzonderlijke indexeerfunctie. |
|
Indexer |
Vertegenwoordigt het cumulatieve runtimeverbruik van de indexeerfunctie in de service. |
|
Indexer |
Vertegenwoordigt de algemene status van de indexeerfunctie. |
|
Indexing |
Geeft de modus aan waarin de indexeerfunctie wordt uitgevoerd. |
|
Search |
Vertegenwoordigt een indexeringsfout op item- of documentniveau. |
|
Search |
Geeft de limieten weer die op een indexer kunnen worden toegepast. |
|
Search |
Vertegenwoordigt de huidige status en uitvoeringsgeschiedenis van een indexeerfunctie. |
|
Search |
Vertegenwoordigt een waarschuwing op itemniveau. |
Accept
De Accepteer kop.
| Waarde | Description |
|---|---|
| application/json;odata.metadata=minimal |
ErrorAdditionalInfo
Aanvullende informatie over de resourcebeheerfout.
| Name | Type | Description |
|---|---|---|
| info |
De aanvullende informatie. |
|
| type |
string |
Het extra informatietype. |
ErrorDetail
Het foutdetail.
| Name | Type | Description |
|---|---|---|
| additionalInfo |
Aanvullende informatie over de fout. |
|
| code |
string |
De foutcode. |
| details |
De foutgegevens. |
|
| message |
string |
Het foutbericht. |
| target |
string |
Het foutdoelwit. |
ErrorResponse
Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)
| Name | Type | Description |
|---|---|---|
| error |
Het foutobject. |
IndexerCurrentState
Vertegenwoordigt alle statussen die de huidige uitvoering van de indexeerfunctie definiëren en dicteren.
| Name | Type | Description |
|---|---|---|
| allDocsFinalTrackingState |
string |
Statuswaarde voor wijzigingen bijhouden wanneer indexering is voltooid voor alle documenten in de gegevensbron. |
| allDocsInitialTrackingState |
string |
Status van wijzigingen bijhouden die wordt gebruikt bij het indexeren van alle documenten in de gegevensbron. |
| mode |
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. |
| resetDocsFinalTrackingState |
string |
Wijzigingsstatuswaarde bijhouden wanneer indexering is voltooid bij selecteren, documenten opnieuw instellen in de gegevensbron. |
| resetDocsInitialTrackingState |
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. |
| resyncFinalTrackingState |
string |
Wijzig de waarde van de volgstatus wanneer het indexeren is voltooid voor selectieve opties uit de gegevensbron. |
| resyncInitialTrackingState |
string |
De status voor het bijhouden van wijzigingen die wordt gebruikt wanneer het indexeren wordt gestart met selectieve opties uit de gegevensbron. |
IndexerExecutionResult
Vertegenwoordigt het resultaat van de uitvoering van een afzonderlijke indexeerfunctie.
| Name | Type | Description |
|---|---|---|
| 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 |
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. |
| mode |
De modus waarin de indexeerfunctie wordt uitgevoerd. |
|
| startTime |
string (date-time) |
De begintijd van de uitvoering van deze indexeerfunctie. |
| status |
Het resultaat van de uitvoering van deze indexeerfunctie. |
|
| statusDetail |
Het resultaat van de uitvoering van deze indexeerfunctie. |
|
| warnings |
De indexeringswaarschuwingen op itemniveau. |
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. |
IndexerExecutionStatusDetail
Geeft details over 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. |
| resync |
Geeft aan dat selectief opnieuw moet worden gesynchroniseerd op basis van optie(s) uit de gegevensbron. |
IndexerRuntime
Vertegenwoordigt het cumulatieve runtimeverbruik van de indexeerfunctie in de service.
| Name | Type | Description |
|---|---|---|
| beginningTime |
string (date-time) |
Begin-UTC-tijd van de periode van 24 uur die wordt beschouwd voor het gebruik van de runtime van de indexeerfunctie (inclusief). |
| endingTime |
string (date-time) |
Einde UTC-tijd van de periode van 24 uur die wordt beschouwd voor het gebruik van de indexerruntime (inclusief). |
| remainingSeconds |
integer (int64) |
Resterende cumulatieve runtime voor alle indexeerfuncties in de service vanaf het beginTijd tot eindTijd, in seconden. |
| usedSeconds |
integer (int64) |
Cumulatieve looptijd van de indexeerfunctie van het beginTijd tot eindeTijd, in seconden. |
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. |
IndexingMode
Geeft de modus aan waarin de indexeerfunctie wordt uitgevoerd.
| Waarde | Description |
|---|---|
| indexingAllDocs |
De indexeerfunctie indexeert alle documenten in de gegevensbron. |
| indexingResetDocs |
De indexeerfunctie indexeert selectieve, opnieuw ingestelde documenten in de gegevensbron. De documenten die worden geïndexeerd, worden gedefinieerd in de status van de indexeerfunctie. |
| indexingResync |
De indexeerfunctie synchroniseert en indexeert selectieve optie(s) uit de gegevensbron. |
SearchIndexerError
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
Geeft de limieten weer die op een indexer kunnen worden toegepast.
| Name | Type | Description |
|---|---|---|
| maxDocumentContentCharactersToExtract |
integer (int64) |
Het maximum aantal tekens dat wordt geëxtraheerd uit een document dat wordt opgehaald voor indexering. |
| maxDocumentExtractionSize |
integer (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 |
|---|---|---|
| currentState |
Alle staten die de huidige uitvoering van de indexeerfunctie definiëren en dicteren. |
|
| executionHistory |
Geschiedenis van de recente uitvoeringen van de indexeerfunctie, gesorteerd in omgekeerde chronologische volgorde. |
|
| lastResult |
Het resultaat van de meest recente uitvoering of een actieve indexeerfunctie. |
|
| limits |
De uitvoeringslimieten voor de indexeerfunctie. |
|
| name |
string |
De naam van de indexeerder. |
| runtime |
Momentopname van het cumulatieve runtimeverbruik van de indexer voor de dienst over de huidige UTC-periode. |
|
| status |
Algemene status van de indexeerfunctie. |
SearchIndexerWarning
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. |