Indexers - Get Status

Serviço:

Search Service

Versão da API:

2026-05-01-preview

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

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string (uri)	A URL do ponto de extremidade do serviço de pesquisa.
indexerName	path	True	string	O nome do indexador.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Accept		Accept	O cabeçalho Aceitar.
x-ms-client-request-id		string (uuid)	Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Respostas

Name	Tipo	Description
200 OK	SearchIndexerStatus	O pedido foi bem-sucedido.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

api-key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Âmbitos

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

Exemplos

SearchServiceGetIndexerStatus

SearchServiceGetS3HDUnlimitedIndexerStatus

SearchServiceGetIndexerStatus

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:

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

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:

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

Definições

Name	Description
Accept	O cabeçalho Aceitar.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.)
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.
IndexerRuntime	Representa o consumo cumulativo de tempo de execução do indexador no serviço.
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	Representa os limites que podem ser aplicados a um indexador.
SearchIndexerStatus	Representa o status atual e o histórico de execução de um indexador.
SearchIndexerWarning	Representa um aviso no nível do item.

Accept

Enumeração

O cabeçalho Aceitar.

Valor	Description
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

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 alvo do erro.

ErrorResponse

Object

Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.)

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

IndexerCurrentState

Object

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

Name	Tipo	Description
allDocsFinalTrackingState	string	Altere o valor do estado de controle quando a indexação for concluída em todos os documentos na fonte de dados.
allDocsInitialTrackingState	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.
resetDocsFinalTrackingState	string	Altere o valor do estado de acompanhamento quando a indexação for concluída ao selecionar e redefinir documentos na fonte de dados.
resetDocsInitialTrackingState	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.
resyncFinalTrackingState	string	Altere o valor do estado de acompanhamento quando a indexação for concluída em opções seletivas da fonte de dados.
resyncInitialTrackingState	string	Altere o estado de controle usado quando a indexação é iniciada em opções seletivas da fonte de dados.

IndexerExecutionResult

Object

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

Name	Tipo	Description
endTime	string (date-time)	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 (int32)	O número de itens que não puderam ser indexados durante essa execução do indexador.
itemsProcessed	integer (int32)	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.
mode	IndexingMode	O modo em que o indexador está sendo executado.
startTime	string (date-time)	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

Enumeração

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

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

IndexerExecutionStatusDetail

Enumeração

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

Valor	Description
resetDocs	Indica que a redefinição que ocorreu foi para uma chamada para ResetDocs.
resync	Indica para ressincronizar seletivamente com base na(s) opção(ões) da fonte de dados.

IndexerRuntime

Object

Representa o consumo cumulativo de tempo de execução do indexador no serviço.

Name	Tipo	Description
beginningTime	string (date-time)	Início da hora UTC do período de 24 horas considerado para o uso do tempo de execução do indexador (inclusive).
endingTime	string (date-time)	Hora UTC final do período de 24 horas considerado para o uso do tempo de execução do indexador (inclusive).
remainingSeconds	integer (int64)	Tempo de execução cumulativo restante para todos os indexadores no serviço desde o inícioTime até o endingTime, em segundos.
usedSeconds	integer (int64)	Tempo de execução cumulativo do indexador desde o inícioTime até o fimTempo, em segundos.

IndexerStatus

Enumeração

Representa o status geral do indexador.

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

IndexingMode

Enumeração

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

Valor	Description
indexingAllDocs	O indexador está indexando todos os documentos na fonte de dados.
indexingResetDocs	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.
indexingResync	O indexador está ressincronizando e indexando a(s) opção(ões) seletiva(s) da fonte de dados.

SearchIndexerError

Object

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 (int32)	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

Object

Representa os limites que podem ser aplicados a um indexador.

Name	Tipo	Description
maxDocumentContentCharactersToExtract	integer (int64)	O número máximo de caracteres que serão extraídos de um documento coletado para indexação.
maxDocumentExtractionSize	integer (int64)	O tamanho máximo de um documento, em bytes, que será considerado válido para indexação.
maxRunTime	string (duration)	A duração máxima que o indexador pode executar para uma execução.

SearchIndexerStatus

Object

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

Name	Tipo	Description
currentState	IndexerCurrentState	Todo o estado que define e dita a execução atual do indexador.
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.
name	string	O nome do indexador.
runtime	IndexerRuntime	Instantânea do consumo cumulativo de tempo de execução do indexador para o serviço ao longo do período UTC atual.
status	IndexerStatus	Status geral do indexador.

SearchIndexerWarning

Object

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.