Indexers - Get Status

Referencia

Servicio:: Search Service

Versión de la API:: 2024-05-01-preview

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

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

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.
indexerName	path	True	string	Nombre del indexador para el que se va a recuperar el estado.
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	SearchIndexerStatus
Other Status Codes	ErrorResponse	Respuesta de error.

Ejemplos

SearchServiceGetIndexerStatus

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 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
  }
}

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
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 una ejecución individual del indexador.
IndexerExecutionStatusDetail	Detalla el estado de una ejecución individual del indexador.
IndexerStatus	Representa el estado general del indexador.
IndexingMode	Representa el modo en el que se está ejecutando el indexador.
SearchIndexerError	Representa un error de indexación de elemento o de nivel de documento.
SearchIndexerLimits
SearchIndexerStatus	Representa el estado actual y el historial de ejecución de un indexador.
SearchIndexerWarning	Representa una advertencia de nivel de elemento.

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

Detalle del error.

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

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

IndexerCurrentState

Object

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

Nombre	Tipo	Description
allDocsFinalChangeTrackingState	string	Valor de estado de seguimiento de cambios cuando la indexación finaliza en todos los documentos del origen de datos.
allDocsInitialChangeTrackingState	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.
resetDocsFinalChangeTrackingState	string	Valor de estado de seguimiento de cambios cuando la indexación finaliza al seleccionar, restablezca los documentos del origen de datos.
resetDocsInitialChangeTrackingState	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.

IndexerExecutionResult

Object

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

Nombre	Tipo	Description
currentState	IndexerCurrentState	Todo el estado que define y dicta la ejecución actual del indexador.
endTime	string (date-time)	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	SearchIndexerError[]	Errores de indexación de nivel de elemento.
finalTrackingState	string	Estado de seguimiento de cambios con el que finalizó una ejecución del indexador.
initialTrackingState	string	Estado de seguimiento de cambios con el que se inició una ejecución del indexador.
itemsFailed	integer (int32)	Número de elementos que no se pudieron indexar durante esta ejecución del indexador.
itemsProcessed	integer (int32)	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 (date-time)	Hora de inicio de esta ejecución del indexador.
status	IndexerExecutionStatus	Resultado de esta ejecución del indexador.
statusDetail	IndexerExecutionStatusDetail	Resultado de esta ejecución del indexador.
warnings	SearchIndexerWarning[]	Advertencias de indexación de nivel de elemento.

IndexerExecutionStatus

Enumeración

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

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

IndexerExecutionStatusDetail

Enumeración

Detalla el estado de una ejecución individual del indexador.

Valor	Description
resetDocs	Indica que el restablecimiento que se produjo fue para una llamada a ResetDocs.

IndexerStatus

Enumeración

Representa el estado general del indexador.

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

IndexingMode

Enumeración

Representa el modo en el que se está ejecutando 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.

SearchIndexerError

Object

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. Esto puede no estar siempre disponible.
documentationLink	string	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 adjunto. Esto puede no estar siempre disponible.
statusCode	integer (int32)	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 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

Object

Nombre	Tipo	Description
maxDocumentContentCharactersToExtract	number (int64)	Número máximo de caracteres que se extraerán de un documento seleccionado para la indexación.
maxDocumentExtractionSize	number (int64)	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

Object

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

Nombre	Tipo	Description
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.
status	IndexerStatus	Estado general del indexador.

SearchIndexerWarning

Object

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. 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 adjunto. Esto puede no estar siempre disponible.

Compartir a través de

Indexers - Get Status

Parámetros de identificador URI

Encabezado de la solicitud

Respuestas

Ejemplos

SearchServiceGetIndexerStatus

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IndexerCurrentState

IndexerExecutionResult

IndexerExecutionStatus

IndexerExecutionStatusDetail

IndexerStatus

IndexingMode

SearchIndexerError

SearchIndexerLimits

SearchIndexerStatus

SearchIndexerWarning