Indexers - Get Status

Referência

Serviço:: Search Service

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

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

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

Parâmetros de URI

Nome	Em	Obrigató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 cujo status deve ser recuperado.
api-version	query	True	string	Versão da API do cliente.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-request-id		string uuid	A ID de rastreamento enviada com a solicitação para ajudar na depuração.

Respostas

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

Exemplos

SearchServiceGetIndexerStatus

Solicitação de exemplo

HTTP

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

Resposta de exemplo

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

Nome	Description
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
IndexerCurrentState	Representa todo o estado que define e determina a execução atual do indexador.
IndexerExecutionResult	Representa o resultado de uma execução individual do indexador.
IndexerExecutionStatus	Representa o status de uma execução do indexador individual.
IndexerExecutionStatusDetail	Detalha o status de uma execução individual do indexador.
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 do item ou documento.
SearchIndexerLimits
SearchIndexerStatus	Representa o histórico de execução e do status atual de um indexador.
SearchIndexerWarning	Representa um aviso no nível do item.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

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

ErrorDetail

O detalhe do erro.

Nome	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 de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

IndexerCurrentState

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

Nome	Tipo	Description
allDocsFinalChangeTrackingState	string	Alterar o valor do estado de controle ao concluir a indexação em todos os documentos na fonte de dados.
allDocsInitialChangeTrackingState	string	Alterar 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á em execução.
resetDatasourceDocumentIds	string[]	A lista de IDs de documento de fonte de dados que foram redefinidas. A ID do documento de fonte de dados é o identificador exclusivo dos dados na fonte de dados. O indexador priorizará a ingestão seletiva dessas IDs.
resetDocsFinalChangeTrackingState	string	Altere o valor do estado de controle quando a indexação for concluída na seleção, redefina documentos na fonte de dados.
resetDocsInitialChangeTrackingState	string	Alterar o estado de controle usado quando a indexação é iniciada na seleção, 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á a ingestão seletiva dessas chaves.

IndexerExecutionResult

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

Nome	Tipo	Description
currentState	IndexerCurrentState	Todo o estado que define e determina 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 uma execução do indexador foi concluída.
initialTrackingState	string	Alterar o estado de controle com o qual uma execução do indexador foi iniciada.
itemsFailed	integer	O número de itens que não foram 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 dessa 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 do indexador individual.

Nome	Tipo	Description
inProgress	string	A execução de indexador está em andamento.
reset	string	O indexador foi redefinido.
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 temporária. As invocações do indexador continuam de acordo com a agenda.

IndexerExecutionStatusDetail

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

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

IndexerStatus

Representa o status geral do indexador.

Nome	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á em execução normalmente.
unknown	string	Indica que o indexador está em um estado desconhecido.

IndexingMode

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

Nome	Tipo	Description
indexingAllDocs	string	O indexador está indexando todos os documentos na fonte de dados.
indexingResetDocs	string	O indexador está indexando documentos seletivos e redefinidos na fonte de dados. Os documentos que estão sendo indexados são definidos no indexador status.

SearchIndexerError

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

Nome	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 origem na qual o erro se originou. Por exemplo, isso pode se referir a uma habilidade específica no conjunto de habilidades anexado. Isso pode nem sempre estar disponível.
statusCode	integer	O código status indicando 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

Nome	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 tem permissão para executar para uma execução.

SearchIndexerStatus

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

Nome	Tipo	Description
executionHistory	IndexerExecutionResult[]	Histórico das execuções recentes do indexador, classificadas 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.

Nome	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 origem na qual o aviso se originou. Por exemplo, isso pode se referir a uma habilidade específica no conjunto de habilidades anexado. Isso pode nem sempre estar disponível.

Compartilhar via