Indexers - Get Status
Devuelve el historial de ejecución y el estado actual de un indizador.
GET {endpoint}/indexers('{indexerName}')/search.status?api-version=2023-11-01
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
Dirección URL del punto de conexión del servicio de búsqueda. |
indexer
|
path | True |
string |
Nombre del indizador cuyo estado se va a recuperar. |
api-version
|
query | True |
string |
Versión de api de cliente. |
Encabezado de la solicitud
Nombre | Requerido | Tipo | Description |
---|---|---|---|
x-ms-client-request-id |
string uuid |
Identificador de seguimiento enviado con la solicitud para ayudar con la depuración. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK | ||
Other Status Codes |
Respuesta de error. |
Ejemplos
SearchServiceGetIndexerStatus
Sample Request
GET https://myservice.search.windows.net/indexers('myindexer')/search.status?api-version=2023-11-01
Sample Response
{
"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
}
}
Definiciones
Nombre | Description |
---|---|
Indexer |
Representa el resultado de una ejecución de indizador individual. |
Indexer |
Representa el estado de una ejecución individual del indizador. |
Indexer |
Representa el estado general del indizador. |
Search |
Describe una condición de error para la API. |
Search |
Representa un error de indización de nivel de elemento o documento. |
Search |
|
Search |
Representa el historial de ejecución y el estado actual de un indizador. |
Search |
Representa una advertencia de nivel de elemento. |
IndexerExecutionResult
Representa el resultado de una ejecución de indizador individual.
Nombre | Tipo | Description |
---|---|---|
endTime |
string |
Hora de finalización de esta ejecución del indexador, si la ejecución ya se ha completado. |
errorMessage |
string |
Mensaje de error que indica el error de nivel superior, si existe. |
errors |
Errores de indexación de nivel de elemento. |
|
finalTrackingState |
string |
Estado de seguimiento de cambios con el que finalizó la ejecución de un indexador. |
initialTrackingState |
string |
Estado de seguimiento de cambios con el que se inició una ejecución del indexador. |
itemsFailed |
integer |
Número de elementos que no se pudieron indizar durante esta ejecución del indexador. |
itemsProcessed |
integer |
Número de elementos que se procesaron durante esta ejecución del indexador. Esto incluye los elementos procesados correctamente y los elementos en los que se intentó la indexación, pero se produjo un error. |
startTime |
string |
Hora de inicio de esta ejecución del indexador. |
status |
Resultado de esta ejecución del indexador. |
|
warnings |
Advertencias de indexación de nivel de elemento. |
IndexerExecutionStatus
Representa el estado de una ejecución individual del indizador.
Nombre | Tipo | Description |
---|---|---|
inProgress |
string |
la ejecución del indizador está en curso. |
reset |
string |
El indizador se ha restablecido. |
success |
string |
La ejecución del indizador se completó correctamente. |
transientFailure |
string |
Error de invocación de un indizador, pero el error puede ser transitorio. Las invocaciones de indizador seguirán según la programación. |
IndexerStatus
Representa el estado general del indizador.
Nombre | Tipo | Description |
---|---|---|
error |
string |
Indica que el indexador experimentó un error que no se puede corregir sin intervención humana. |
running |
string |
Indica que el indexador se está ejecutando normalmente. |
unknown |
string |
Indica que el indexador está en un estado desconocido. |
SearchError
Describe una condición de error para la API.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Uno de los conjuntos de códigos de error definidos por el servidor. |
details |
Matriz de detalles sobre errores específicos que llevaron a este error notificado. |
|
message |
string |
Representación legible del error. |
SearchIndexerError
Representa un error de indización de nivel de elemento o documento.
Nombre | Tipo | Description |
---|---|---|
details |
string |
Detalles detallados adicionales sobre el error para ayudar a depurar el indexador. Esto puede no estar siempre disponible. |
documentationLink |
string |
Un vínculo a una guía de solución de problemas para estas clases de errores. Esto puede no estar siempre disponible. |
errorMessage |
string |
Mensaje que describe el error que se produjo al procesar el elemento. |
key |
string |
Clave del elemento para el que se produjo un error en la indexación. |
name |
string |
nombre del origen en el que se originó el error. Por ejemplo, esto podría hacer referencia a una aptitud determinada en el conjunto de aptitudes adjuntas. Esto puede no estar siempre disponible. |
statusCode |
integer |
Código de estado que indica por qué se produjo un error en la operación de indexación. Entre los valores posibles se incluyen: 400 para un documento de entrada con formato incorrecto, 404 para el documento no encontrado, 409 para un conflicto de versión, 422 cuando el índice no está disponible temporalmente o 503 para cuando el servicio está demasiado ocupado. |
SearchIndexerLimits
Nombre | Tipo | Description |
---|---|---|
maxDocumentContentCharactersToExtract |
number |
Número máximo de caracteres que se extraerán de un documento seleccionado para la indexación. |
maxDocumentExtractionSize |
number |
Tamaño máximo de un documento, en bytes, que se considerará válido para la indexación. |
maxRunTime |
string |
La duración máxima que el indexador puede ejecutar para una ejecución. |
SearchIndexerStatus
Representa el historial de ejecución y el estado actual de un indizador.
Nombre | Tipo | Description |
---|---|---|
executionHistory |
Historial de ejecuciones de indexador recientes, ordenadas en orden cronológico inverso. |
|
lastResult |
Resultado de la ejecución más reciente o en curso del indizador. |
|
limits |
Límites de ejecución para el indexador. |
|
status |
Estado general del indizador. |
SearchIndexerWarning
Representa una advertencia de nivel de elemento.
Nombre | Tipo | Description |
---|---|---|
details |
string |
Detalles adicionales detallados sobre la advertencia para ayudar a depurar el indexador. Esto puede no estar siempre disponible. |
documentationLink |
string |
Vínculo a una guía de solución de problemas para estas clases de advertencias. Esto puede no estar siempre disponible. |
key |
string |
Clave del elemento que generó una advertencia. |
message |
string |
Mensaje que describe la advertencia que se produjo al procesar el elemento. |
name |
string |
Nombre del origen en el que se originó la advertencia. Por ejemplo, esto podría hacer referencia a una aptitud determinada en el conjunto de aptitudes adjuntas. Esto puede no estar siempre disponible. |