Knowledge Sources - Get Status

Serviço:: Search Service

Versão da API:: 2026-04-01

Recupera o status de uma fonte de conhecimento.

GET {endpoint}/knowledgesources('{sourceName}')/status?api-version=2026-04-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string (uri)	A URL do ponto de extremidade do serviço de pesquisa.
sourceName	path	True	string	O nome da fonte de conhecimento.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigató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

Nome	Tipo	Description
200 OK	KnowledgeSourceStatus	A solicitação foi bem-sucedida.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

api-key

Tipo: apiKey
Em: header

OAuth2Auth

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

Escopos

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

Exemplos

SearchServiceGetKnowledgeSourceStatus

Solicitação de exemplo

HTTP

GET https://exampleservice.search.windows.net/knowledgesources('ks-example-index')/status?api-version=2026-04-01

Resposta de exemplo

Código de status:: 200

{
  "kind": "searchIndex",
  "synchronizationStatus": "active",
  "synchronizationInterval": "1d",
  "currentSynchronizationState": {
    "startTime": "2024-11-26T03:37:18.853Z",
    "itemsUpdatesProcessed": 10,
    "itemsUpdatesFailed": 2,
    "itemsSkipped": 1
  },
  "lastSynchronizationState": {
    "startTime": "2024-11-25T03:37:18.853Z",
    "endTime": "2024-11-25T03:38:19.012Z",
    "itemsUpdatesProcessed": 8,
    "itemsUpdatesFailed": 1,
    "itemsSkipped": 0
  },
  "statistics": {
    "totalSynchronization": 5,
    "averageSynchronizationDuration": "PT30M",
    "averageItemsProcessedPerSynchronization": 100
  }
}

Definições

Nome	Description
Accept	O cabeçalho Aceitar.
CompletedSynchronizationState	Representa o estado concluído da última sincronização.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta comum de erro para todas as APIs do Azure Resource Manager devolver detalhes de erro em operações falhadas. (Isso também segue o formato de resposta de erro OData.).
KnowledgeSourceKind	O tipo de fonte de conhecimento.
KnowledgeSourceStatistics	Informações estatísticas sobre o histórico de sincronização da fonte de conhecimento.
KnowledgeSourceStatus	Representa o status e o histórico de sincronização de uma fonte de conhecimento.
KnowledgeSourceSynchronizationError	Representa um erro de indexação em nível de documento encontrado durante uma execução de sincronização de fonte de conhecimento.
KnowledgeSourceSynchronizationStatus	O status de sincronização atual da fonte de conhecimento.
SynchronizationState	Representa o estado atual de uma sincronização contínua que abrange várias execuções do indexador.

Accept

Enumeração

O cabeçalho Aceitar.

Valor	Description
application/json;odata.metadata=minimal

CompletedSynchronizationState

Objeto

Representa o estado concluído da última sincronização.

Nome	Tipo	Description
endTime	string (date-time)	A hora de término da última sincronização concluída.
itemsSkipped	integer (int32)	O número de itens ignorados na última sincronização.
itemsUpdatesFailed	integer (int32)	O número de atualizações de itens que falharam na última sincronização.
itemsUpdatesProcessed	integer (int32)	O número de atualizações de item processadas com êxito na última sincronização.
startTime	string (date-time)	A hora de início da última sincronização concluída.

ErrorAdditionalInfo

Objeto

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

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

ErrorDetail

Objeto

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

Objeto

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

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

KnowledgeSourceKind

Enumeração

O tipo de fonte de conhecimento.

Valor	Description
searchIndex	Uma fonte de conhecimento que lê dados de um Índice de Pesquisa.
azureBlob	Uma fonte de conhecimento que lê e ingere dados do Armazenamento de Blobs do Azure em um Índice de Pesquisa.
indexedOneLake	Uma fonte de conhecimento que lê dados do OneLake indexado.
web	Uma fonte de conhecimento que lê dados da web.

KnowledgeSourceStatistics

Objeto

Informações estatísticas sobre o histórico de sincronização da fonte de conhecimento.

Nome	Tipo	Description
averageItemsProcessedPerSynchronization	integer (int32)	Itens médios processados por sincronização.
averageSynchronizationDuration	string	Duração média de sincronização no formato HH:MM:SS.
totalSynchronization	integer (int32)	Número total de sincronizações.

KnowledgeSourceStatus

Objeto

Representa o status e o histórico de sincronização de uma fonte de conhecimento.

Nome	Tipo	Description
currentSynchronizationState	SynchronizationState	Estado de sincronização atual que abrange várias execuções do indexador.
kind	KnowledgeSourceKind	Identifica o tipo Fonte de Conhecimento diretamente a partir da resposta de Status.
lastSynchronizationState	CompletedSynchronizationState	Detalhes da última sincronização concluída. Nulo na primeira sincronização.
statistics	KnowledgeSourceStatistics	Informações estatísticas sobre o histórico de sincronização da fonte de conhecimento. Nulo na primeira sincronização.
synchronizationInterval	string	O intervalo de sincronização (por exemplo, '1d' para diário). Nulo se nenhum agendamento estiver configurado.
synchronizationStatus	KnowledgeSourceSynchronizationStatus	O status atual da sincronização.

KnowledgeSourceSynchronizationError

Objeto

Representa um erro de indexação em nível de documento encontrado durante uma execução de sincronização de fonte de conhecimento.

Nome	Tipo	Description
details	string	Informações contextuais adicionais sobre a falha.
docId	string	O identificador único para o documento ou item que falhou dentro da execução de sincronização.
documentationLink	string	Um link para a documentação relevante de solução de problemas.
errorMessage	string	Mensagem de erro legível para humanos, visível para o cliente.
name	string	Nome do componente de ingestão ou processamento que reporta o erro.
statusCode	integer (int32)	Código de status semelhante a HTTP representando a categoria de falha (por exemplo, 400).

KnowledgeSourceSynchronizationStatus

Enumeração

O status de sincronização atual da fonte de conhecimento.

Valor	Description
creating	A fonte de conhecimento está sendo provisionada.
active	A fonte de conhecimento está ativa e as execuções de sincronização estão ocorrendo.
deleting	A fonte de conhecimento está sendo excluída e a sincronização está pausada.

SynchronizationState

Objeto

Representa o estado atual de uma sincronização contínua que abrange várias execuções do indexador.

Nome	Tipo	Description
errors	KnowledgeSourceSynchronizationError[]	Coleção de erros de indexação em nível de documento encontrados durante a execução atual de sincronização. Retornado somente quando há erros presentes.
itemsSkipped	integer (int32)	O número de itens ignorados na sincronização atual.
itemsUpdatesFailed	integer (int32)	O número de atualizações de itens que falharam na sincronização atual.
itemsUpdatesProcessed	integer (int32)	O número de atualizações de item processadas com êxito na sincronização atual.
startTime	string (date-time)	A hora de início da sincronização atual.