Indexers - Get Status

Referência

Serviço:: Search Service

Versão da API:: 2024-05-01-preview

Devolve o estado atual e o histórico de execuções de um indexador.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	O URL do ponto final do serviço de pesquisa.
indexerName	path	True	string	O nome do indexador para o qual obter o estado.
api-version	query	True	string	Versão da API do Cliente.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-request-id		string uuid	O ID de controlo enviado com o pedido para ajudar na depuração.

Respostas

Name	Tipo	Description
200 OK	SearchIndexerStatus
Other Status Codes	ErrorResponse	Resposta de erro.

Exemplos

SearchServiceGetIndexerStatus

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 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
  }
}

Definições

Name	Description
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
IndexerCurrentState	Representa todo o estado que define e dita a execução atual do indexador.
IndexerExecutionResult	Representa o resultado de uma execução individual do indexador.
IndexerExecutionStatus	Representa o estado de uma execução de indexador individual.
IndexerExecutionStatusDetail	Detalha o estado da execução de um indexador individual.
IndexerStatus	Representa o estado geral do indexador.
IndexingMode	Representa o modo em que o indexador está a ser executado.
SearchIndexerError	Representa um erro de indexação ao nível do item ou do documento.
SearchIndexerLimits
SearchIndexerStatus	Representa o estado atual e o histórico de execuções de um indexador.
SearchIndexerWarning	Representa um aviso ao nível do item.

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informações adicionais.

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

IndexerCurrentState

Representa todo o estado que define e dita a execução atual do indexador.

Name	Tipo	Description
allDocsFinalChangeTrackingState	string	O valor do estado de controlo de alterações ao indexar termina em todos os documentos na origem de dados.
allDocsInitialChangeTrackingState	string	Estado de controlo de alterações utilizado quando a indexação começa em todos os documentos na origem de dados.
mode	IndexingMode	O modo em que o indexador está a ser executado.
resetDatasourceDocumentIds	string[]	A lista de IDs de documentos de origem de dados que foram repostos. O ID do documento da origem de dados é o identificador exclusivo dos dados na origem de dados. O indexador priorizará a ingestão seletiva destes IDs de forma seletiva.
resetDocsFinalChangeTrackingState	string	Altere o valor do estado de controlo quando a indexação terminar ao selecionar e repor documentos na origem de dados.
resetDocsInitialChangeTrackingState	string	Estado de controlo de alterações utilizado quando a indexação começa na seleção, reponha os documentos na origem de dados.
resetDocumentKeys	string[]	A lista de chaves de documento que foram repostas. A chave do documento é o identificador exclusivo do documento para os dados no índice de pesquisa. O indexador irá priorizar a ingestão seletiva destas chaves.

IndexerExecutionResult

Representa o resultado de uma execução individual do indexador.

Name	Tipo	Description
currentState	IndexerCurrentState	Todo o estado que define e dita a execução atual do indexador.
endTime	string	A hora de fim desta execução do indexador, se a execução já tiver sido concluída.
errorMessage	string	A mensagem de erro que indica o erro de nível superior, se existir.
errors	SearchIndexerError[]	Os erros de indexação ao nível do item.
finalTrackingState	string	Estado de controlo de alterações com o qual foi concluída uma execução do indexador.
initialTrackingState	string	Estado de controlo de alterações com o qual foi iniciada uma execução do indexador.
itemsFailed	integer	O número de itens que não foram indexados durante a execução deste indexador.
itemsProcessed	integer	O número de itens que foram processados durante a execução deste indexador. Isto inclui itens processados com êxito e itens em que a indexação foi tentada, mas falhou.
startTime	string	A hora de início desta execução do indexador.
status	IndexerExecutionStatus	O resultado desta execução do indexador.
statusDetail	IndexerExecutionStatusDetail	O resultado desta execução do indexador.
warnings	SearchIndexerWarning[]	Os avisos de indexação ao nível do item.

IndexerExecutionStatus

Representa o estado de uma execução de indexador individual.

Name	Tipo	Description
inProgress	string	A execução do indexador está em curso.
reset	string	O indexador foi reposto.
success	string	A execução do indexador foi concluída com êxito.
transientFailure	string	Uma invocação do indexador falhou, mas a falha pode ser transitória. As invocações do indexador continuarão de acordo com o agendamento.

IndexerExecutionStatusDetail

Detalha o estado da execução de um indexador individual.

Name	Tipo	Description
resetDocs	string	Indica que a reposição que ocorreu foi para uma chamada para ResetDocs.

IndexerStatus

Representa o estado geral do indexador.

Name	Tipo	Description
error	string	Indica que o indexador sofreu um erro que não pode ser corrigido sem intervenção humana.
running	string	Indica que o indexador está a ser executado normalmente.
unknown	string	Indica que o indexador está num estado desconhecido.

IndexingMode

Representa o modo em que o indexador está a ser executado.

Name	Tipo	Description
indexingAllDocs	string	O indexador está a indexar todos os documentos na origem de dados.
indexingResetDocs	string	O indexador está a indexar documentos seletivos e repostos na origem de dados. Os documentos que estão a ser indexados são definidos no estado do indexador.

SearchIndexerError

Representa um erro de indexação ao nível do item ou do documento.

Name	Tipo	Description
details	string	Detalhes verbosos adicionais sobre o erro para ajudar na depuração do indexador. Isto pode nem sempre estar disponível.
documentationLink	string	Uma ligação para um guia de resolução de problemas para estas classes de erros. Isto pode nem sempre estar disponível.
errorMessage	string	A mensagem que descreve o erro que ocorreu durante o processamento do item.
key	string	A chave do item para o qual a indexação falhou.
name	string	O nome da origem na qual o erro teve origem. Por exemplo, isto pode referir-se a uma determinada competência no conjunto de competências anexado. Isto pode nem sempre estar disponível.
statusCode	integer	O código de estado que indica o motivo pelo qual a operação de indexação falhou. Os valores possíveis incluem: 400 para um documento de entrada com formato incorreto, 404 para documento não encontrado, 409 para um conflito de versão, 422 quando o índice está temporariamente indisponível ou 503 para quando o serviço está demasiado ocupado.

SearchIndexerLimits

Name	Tipo	Description
maxDocumentContentCharactersToExtract	number	O número máximo de carateres que serão extraídos de um documento recolhido para indexação.
maxDocumentExtractionSize	number	O tamanho máximo de um documento, em bytes, que será considerado válido para indexação.
maxRunTime	string	A duração máxima que o indexador tem permissão para ser executado para uma execução.

SearchIndexerStatus

Representa o estado atual e o histórico de execuções de um indexador.

Name	Tipo	Description
executionHistory	IndexerExecutionResult[]	Histórico das execuções recentes do indexador, ordenado por ordem cronológica inversa.
lastResult	IndexerExecutionResult	O resultado da execução mais recente ou de um indexador em curso.
limits	SearchIndexerLimits	Os limites de execução do indexador.
status	IndexerStatus	Estado geral do indexador.

SearchIndexerWarning

Representa um aviso ao nível do item.

Name	Tipo	Description
details	string	Detalhes verbosos adicionais sobre o aviso para ajudar na depuração do indexador. Isto pode nem sempre estar disponível.
documentationLink	string	Uma ligação para um guia de resolução de problemas para estas classes de avisos. Isto pode nem sempre estar disponível.
key	string	A chave do item que gerou um aviso.
message	string	A mensagem que descreve o aviso que ocorreu durante o processamento do item.
name	string	O nome da origem na qual o aviso teve origem. Por exemplo, isto pode referir-se a uma determinada competência no conjunto de competências anexado. Isto pode nem sempre estar disponível.

Partilhar via