Indexers - Get Status

Servicio:: Search Service

Versión de la API:: 2025-11-01-preview

Devuelve el estado actual y el historial de ejecución de un indexador.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string (uri)	La dirección URL del punto de conexión del servicio de búsqueda.
indexerName	path	True	string	Nombre del indizador.
api-version	query	True	string minLength: 1	Versión de API que se usará para la operación.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Accept		Accept	El encabezado Aceptar.
x-ms-client-request-id		string (uuid)	Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Respuestas

Nombre	Tipo	Description
200 OK	SearchIndexerStatus	La solicitud se ha realizado correctamente.
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

api-key

Tipo: apiKey
En: header

OAuth2Auth

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ámbitos

Nombre	Description
https://search.azure.com/.default

Ejemplos

SearchServiceGetIndexerStatus

SearchServiceGetS3HDUnlimitedIndexerStatus

SearchServiceGetIndexerStatus

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 200

{
  "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

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 200

{
  "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": []
  }
}

Definiciones

Nombre	Description
Accept	El encabezado Aceptar.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).
IndexerCurrentState	Representa todo el estado que define y dicta la ejecución actual del indexador.
IndexerExecutionResult	Representa el resultado de una ejecución individual del indexador.
IndexerExecutionStatus	Representa el estado de la ejecución de un indexador individual.
IndexerExecutionStatusDetail	Detalla el estado de la ejecución de un indexador individual.
IndexerRuntime	Representa el consumo acumulado en tiempo de ejecución del indexador en el servicio.
IndexerStatus	Representa el estado general del indexador.
IndexingMode	Representa el modo en el que se ejecuta el indexador.
SearchIndexerError	Representa un error de indexación de elemento o de nivel de documento.
SearchIndexerLimits	Representa los límites que se pueden aplicar a un indexador.
SearchIndexerStatus	Representa el estado actual y el historial de ejecución de un indexador.
SearchIndexerWarning	Representa una advertencia de nivel de elemento.

Accept

Enumeración

El encabezado Aceptar.

Valor	Description
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Objeto

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info		Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Objeto

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Objeto

Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

IndexerCurrentState

Objeto

Representa todo el estado que define y dicta la ejecución actual del indexador.

Nombre	Tipo	Description
allDocsFinalTrackingState	string	Valor de estado de seguimiento de cambios cuando la indexación finaliza en todos los documentos del origen de datos.
allDocsInitialTrackingState	string	Estado de seguimiento de cambios usado al iniciar la indexación en todos los documentos del origen de datos.
mode	IndexingMode	Modo en el que se ejecuta el indexador.
resetDatasourceDocumentIds	string[]	Lista de identificadores de documento de origen de datos que se han restablecido. El identificador del documento del origen de datos es el identificador único de los datos del origen de datos. El indexador priorizará la reingestión selectiva de estos identificadores.
resetDocsFinalTrackingState	string	Valor de estado de seguimiento de cambios cuando la indexación finaliza al seleccionar, restablezca los documentos del origen de datos.
resetDocsInitialTrackingState	string	Estado de seguimiento de cambios usado al iniciar la indexación al seleccionar, restablezca los documentos del origen de datos.
resetDocumentKeys	string[]	Lista de claves de documento que se han restablecido. La clave de documento es el identificador único del documento para los datos del índice de búsqueda. El indexador priorizará la reingestión selectiva de estas claves.
resyncFinalTrackingState	string	Cambie el valor del estado de seguimiento cuando finalice la indexación en las opciones selectivas del origen de datos.
resyncInitialTrackingState	string	Cambie el estado de seguimiento utilizado cuando se inicia la indexación en opciones selectivas del origen de datos.

IndexerExecutionResult

Objeto

Representa el resultado de una ejecución individual del indexador.

Nombre	Tipo	Description
endTime	string (date-time)	La hora de finalización de la ejecución de este indexador, si la ejecución ya se ha completado.
errorMessage	string	El mensaje de error que indica el error de nivel superior, si lo hay.
errors	SearchIndexerError[]	Los errores de indexación a nivel de elemento.
finalTrackingState	string	Cambiar el estado de seguimiento con el que finalizó la ejecución de un indexador.
initialTrackingState	string	Estado de seguimiento de cambios con el que se inició la ejecución de un indexador.
itemsFailed	integer (int32)	Número de elementos que no se pudieron indexar durante la ejecución de este indexador.
itemsProcessed	integer (int32)	Número de elementos que se procesaron durante la ejecución de este indizador. Esto incluye tanto los elementos procesados correctamente como los elementos en los que se intentó la indexación pero se produjo un error.
mode	IndexingMode	Modo en el que se ejecuta el indexador.
startTime	string (date-time)	Hora de inicio de la ejecución de este indexador.
status	IndexerExecutionStatus	El resultado de esta ejecución del indexador.
statusDetail	IndexerExecutionStatusDetail	El resultado de esta ejecución del indexador.
warnings	SearchIndexerWarning[]	Las advertencias de indexación de nivel de elemento.

IndexerExecutionStatus

Enumeración

Representa el estado de la ejecución de un indexador individual.

Valor	Description
transientFailure	Se ha producido un error en la invocación de un indexador, pero el error puede ser transitorio. Las invocaciones del indexador continuarán según la programación.
success	La ejecución del indexador se completó correctamente.
inProgress	La ejecución del indexador está en curso.
reset	Se ha restablecido el indexador.

IndexerExecutionStatusDetail

Enumeración

Detalla el estado de la ejecución de un indexador individual.

Valor	Description
resetDocs	Indica que el restablecimiento que se produjo fue para una llamada a ResetDocs.
resync	Indica que se debe volver a sincronizar selectivamente en función de las opciones del origen de datos.

IndexerRuntime

Objeto

Representa el consumo acumulado en tiempo de ejecución del indexador en el servicio.

Nombre	Tipo	Description
beginningTime	string (date-time)	Hora UTC inicial del período de 24 horas considerado para el uso en tiempo de ejecución del indexador (inclusive).
endingTime	string (date-time)	Hora UTC de finalización del período de 24 horas considerado para el uso en tiempo de ejecución del indexador (inclusive).
remainingSeconds	integer (int64)	Tiempo de ejecución acumulativo restante para todos los indexadores del servicio desde beginningTime hasta endingTime, en segundos.
usedSeconds	integer (int64)	Tiempo de ejecución acumulado del indexador desde beginningTime hasta endingTime, en segundos.

IndexerStatus

Enumeración

Representa el estado general del indexador.

Valor	Description
unknown	Indica que el indexador se encuentra en un estado desconocido.
error	Indica que el indexador experimentó un error que no se puede corregir sin intervención humana.
running	Indica que el indexador se ejecuta normalmente.

IndexingMode

Enumeración

Representa el modo en el que se ejecuta el indexador.

Valor	Description
indexingAllDocs	El indexador indexa todos los documentos del origen de datos.
indexingResetDocs	El indexador está indexando documentos selectivos y restablecidos en el origen de datos. Los documentos que se indexan se definen en el estado del indexador.
indexingResync	El indexador está resincronizando e indexando opciones selectivas desde el origen de datos.

SearchIndexerError

Objeto

Representa un error de indexación de elemento o de nivel de documento.

Nombre	Tipo	Description
details	string	Detalles adicionales y detallados sobre el error para ayudar a depurar el indexador. Es posible que no siempre esté disponible.
documentationLink	string	Un enlace a una guía de solución de problemas para estas clases de errores. Es posible que no siempre esté disponible.
errorMessage	string	El 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	El nombre de la fuente en la que se originó el error. Por ejemplo, esto podría referirse a una habilidad particular en el conjunto de habilidades adjuntas. Es posible que no siempre esté disponible.
statusCode	integer (int32)	El código de estado que indica por qué se produjo un error en la operación de indexación. Los valores posibles incluyen: 400 para un documento de entrada con formato incorrecto, 404 para un 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

Objeto

Representa los límites que se pueden aplicar a un indexador.

Nombre	Tipo	Description
maxDocumentContentCharactersToExtract	integer (int64)	El número máximo de caracteres que se extraerán de un documento seleccionado para la indexación.
maxDocumentExtractionSize	integer (int64)	El tamaño máximo de un documento, en bytes, que se considerará válido para la indexación.
maxRunTime	string (duration)	Duración máxima que el indexador puede ejecutar para una ejecución.

SearchIndexerStatus

Objeto

Representa el estado actual y el historial de ejecución de un indexador.

Nombre	Tipo	Description
currentState	IndexerCurrentState	Todo el estado que define y dicta la ejecución actual del indexador.
executionHistory	IndexerExecutionResult[]	Historial de las ejecuciones recientes del indexador, ordenadas en orden cronológico inverso.
lastResult	IndexerExecutionResult	Resultado de la ejecución del indexador en curso o más reciente.
limits	SearchIndexerLimits	Límites de ejecución para el indexador.
name	string	Nombre del indizador.
runtime	IndexerRuntime	Instantánea del consumo acumulado en tiempo de ejecución del indexador para el servicio durante el periodo UTC actual.
status	IndexerStatus	Estado general del indexador.

SearchIndexerWarning

Objeto

Representa una advertencia de nivel de elemento.

Nombre	Tipo	Description
details	string	Detalles adicionales y detallados sobre la advertencia para ayudar a depurar el indexador. Es posible que no siempre esté disponible.
documentationLink	string	Un vínculo a una guía de solución de problemas para estas clases de advertencias. Es posible que no siempre esté disponible.
key	string	La clave del elemento que generó una advertencia.
message	string	El mensaje que describe la advertencia que se produjo al procesar el elemento.
name	string	El nombre de la fuente en la que se originó la advertencia. Por ejemplo, esto podría referirse a una habilidad particular en el conjunto de habilidades adjuntas. Es posible que no siempre esté disponible.