Knowledge Sources - Get Status

Serviço:: Search Service

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

Recupera o estado de uma fonte de conhecimento.

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

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.
sourceName	path	True	string	O nome da fonte de conhecimento.
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 string opaco, globalmente único e gerado pelo cliente para o pedido.

Respostas

Name	Tipo	Description
200 OK	KnowledgeSourceStatus	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

SearchServiceGetKnowledgeSourceStatus

Pedido de amostra

HTTP

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

Resposta da amostra

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

Name	Description
Accept	O cabeçalho Aceitar.
CompletedSynchronizationState	Representa o estado concluído da última sincronização.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro comum para todas as APIs do Azure Resource Manager devolver detalhes de erro para 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 ao nível do 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 de indexador.

Accept

Enumeração

O cabeçalho Aceitar.

Valor	Description
application/json;odata.metadata=minimal

CompletedSynchronizationState

Object

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

Name	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 item 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

Object

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

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

ErrorResponse

Object

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

Name	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 para 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

Object

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

Name	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

Object

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

Name	Tipo	Description
currentSynchronizationState	SynchronizationState	Estado de sincronização atual que abrange várias execuções de indexador.
kind	KnowledgeSourceKind	Identifica o tipo Fonte de Conhecimento diretamente a partir da resposta de Estado.
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 diariamente). Nulo se nenhuma agenda estiver configurada.
synchronizationStatus	KnowledgeSourceSynchronizationStatus	O estado atual da sincronização.

KnowledgeSourceSynchronizationError

Object

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

Name	Tipo	Description
details	string	Informação contextual adicional sobre a falha.
docId	string	O identificador único para o documento ou item falhado dentro da execução de sincronização.
documentationLink	string	Um link para a documentação relevante de resoluçã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 estado semelhante a HTTP que representa 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 é pausada.

SynchronizationState

Object

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

Name	Tipo	Description
errors	KnowledgeSourceSynchronizationError[]	Coleção de erros de indexação ao nível do documento encontrados durante a execução atual da sincronização. Devolvido apenas 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 item 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.