Indexers - Get Status

Referência

Serviço:: Search Service

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

Retorna o status atual e o histórico de execução de um indexador.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	A URL do ponto de extremidade do serviço de pesquisa.
indexerName	path	True	string	O nome do indexador para o qual recuperar o status.
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 rastreamento enviado com a solicitação para ajudar com a 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-09-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	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
IndexerCurrentState	Representa todo o estado que define e dita a execução atual do indexador.
IndexerExecutionResult	Representa o resultado de uma execução de indexador individual.
IndexerExecutionStatus	Representa o status de uma execução de indexador individual.
IndexerExecutionStatusDetail	Detalha o status de uma execução de indexador individual.
IndexerStatus	Representa o status geral do indexador.
IndexingMode	Representa o modo em que o indexador está sendo executado.
SearchIndexerError	Representa um erro de indexação no nível de item ou documento.
SearchIndexerLimits
SearchIndexerStatus	Representa o status atual e o histórico de execução de um indexador.
SearchIndexerWarning	Representa um aviso no nível do item.

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

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

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
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 de erro

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	Altere o valor do estado de controle quando a indexação for concluída em todos os documentos na fonte de dados.
allDocsInitialChangeTrackingState	string	Altere o estado de controle usado quando a indexação é iniciada em todos os documentos na fonte de dados.
mode	IndexingMode	O modo em que o indexador está sendo executado.
resetDatasourceDocumentIds	string[]	A lista de ids de documento da fonte de dados que foram redefinidas. A ID do documento da fonte de dados é o identificador exclusivo para os dados na fonte de dados. O indexador priorizará seletivamente a reingestão desses ids.
resetDocsFinalChangeTrackingState	string	Altere o valor do estado de acompanhamento quando a indexação for concluída ao selecionar e redefinir documentos na fonte de dados.
resetDocsInitialChangeTrackingState	string	Altere o estado de controle usado quando a indexação é iniciada ao selecionar, redefinir documentos na fonte de dados.
resetDocumentKeys	string[]	A lista de chaves de documento que foram redefinidas. A chave do documento é o identificador exclusivo do documento para os dados no índice de pesquisa. O indexador priorizará seletivamente a reingestão dessas chaves.

IndexerExecutionResult

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

Name	Tipo	Description
currentState	IndexerCurrentState	Todo o estado que define e dita a execução atual do indexador.
endTime	string	A hora de término dessa 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 houver.
errors	SearchIndexerError[]	Os erros de indexação no nível do item.
finalTrackingState	string	Alterar o estado de controle com o qual a execução de um indexador foi concluída.
initialTrackingState	string	Alterar o estado de controle com o qual uma execução de indexador foi iniciada.
itemsFailed	integer	O número de itens que não puderam ser indexados durante essa execução do indexador.
itemsProcessed	integer	O número de itens que foram processados durante essa execução do indexador. Isso 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 dessa execução do indexador.
statusDetail	IndexerExecutionStatusDetail	O resultado dessa execução do indexador.
warnings	SearchIndexerWarning[]	Os avisos de indexação no nível do item.

IndexerExecutionStatus

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

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

IndexerExecutionStatusDetail

Detalha o status de uma execução de indexador individual.

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

IndexerStatus

Representa o status geral do indexador.

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

IndexingMode

Representa o modo em que o indexador está sendo executado.

Name	Tipo	Description
indexingAllDocs	string	O indexador está indexando todos os documentos na fonte de dados.
indexingResetDocs	string	O indexador está indexando seletivamente, redefinir documentos na fonte de dados. Os documentos que estão sendo indexados são definidos no status do indexador.

SearchIndexerError

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

Name	Tipo	Description
details	string	Detalhes adicionais e detalhados sobre o erro para ajudar na depuração do indexador. Isso pode nem sempre estar disponível.
documentationLink	string	Um link para um guia de solução de problemas para essas classes de erros. Isso 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 fonte na qual o erro se originou. Por exemplo, isto pode referir-se a uma competência específica no conjunto de competências em anexo. Isso pode nem sempre estar disponível.
statusCode	integer	O código de status que indica por que a operação de indexação falhou. Os valores possíveis incluem: 400 para um documento de entrada malformado, 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á muito ocupado.

SearchIndexerLimits

Name	Tipo	Description
maxDocumentContentCharactersToExtract	number	O número máximo de caracteres que serão extraídos de um documento coletado 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 pode executar para uma execução.

SearchIndexerStatus

Representa o status atual e o histórico de execução de um indexador.

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

SearchIndexerWarning

Representa um aviso no nível do item.

Name	Tipo	Description
details	string	Detalhes adicionais e detalhados sobre o aviso para ajudar na depuração do indexador. Isso pode nem sempre estar disponível.
documentationLink	string	Um link para um guia de solução de problemas para essas classes de avisos. Isso 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 fonte de origem do aviso. Por exemplo, isto pode referir-se a uma competência específica no conjunto de competências em anexo. Isso pode nem sempre estar disponível.

Partilhar via