Knowledge Sources - Get Status

Служба:: Search Service

Версия API:: 2025-11-01-preview

Получает статус источника знаний.

GET {endpoint}/knowledgesources('{sourceName}')/status?api-version=2025-11-01-preview

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)	URL-адрес конечной точки службы поиска.
sourceName	path	True	string	Название источника знаний.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Заголовок запроса

Имя	Обязательно	Тип	Описание
Accept		Accept	Заголовок Accept.
x-ms-client-request-id		string (uuid)	Непрозрачный, глобально уникальный, созданный клиентом идентификатор строки для запроса.

Ответы

Имя	Тип	Описание
200 OK	KnowledgeSourceStatus	Запрос выполнен успешно.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

api-key

Тип: apiKey
В: header

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Области

Имя	Описание
https://search.azure.com/.default

Примеры

SearchServiceGetKnowledgeSourceStatus

Образец запроса

HTTP

GET https://previewexampleservice.search.windows.net/knowledgesources('ks-preview-test')/status?api-version=2025-11-01-preview

Пример ответа

Код состояния:: 200

{
  "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
  }
}

Определения

Имя	Описание
Accept	Заголовок Accept.
CompletedSynchronizationState	Представляет собой завершенное состояние последней синхронизации.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).
KnowledgeSourceStatistics	Статистическая информация об истории синхронизации источников знаний.
KnowledgeSourceStatus	Представляет состояние и историю синхронизации источника знаний.
KnowledgeSourceSynchronizationStatus	Текущее состояние синхронизации источника знаний.
SynchronizationState	Представляет текущее состояние текущей синхронизации, охватывающей несколько запусков индексатора.

Accept

Перечисление

Заголовок Accept.

Значение	Описание
application/json;odata.metadata=minimal

CompletedSynchronizationState

Объект

Представляет собой завершенное состояние последней синхронизации.

Имя	Тип	Описание
endTime	string (date-time)	Время окончания последней завершенной синхронизации.
itemsSkipped	integer (int32)	Количество элементов, пропущенных при последней синхронизации.
itemsUpdatesFailed	integer (int32)	Количество обновлений элементов, завершившихся сбоем при последней синхронизации.
itemsUpdatesProcessed	integer (int32)	Количество обновлений элементов, успешно обработанных во время последней синхронизации.
startTime	string (date-time)	Время начала последней завершенной синхронизации.

ErrorAdditionalInfo

Объект

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info		Дополнительная информация.
type	string	Тип дополнительной информации.

ErrorDetail

Объект

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Ошибка дополнительная информация.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Цель ошибки.

ErrorResponse

Объект

Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

KnowledgeSourceStatistics

Объект

Статистическая информация об истории синхронизации источников знаний.

Имя	Тип	Описание
averageItemsProcessedPerSynchronization	integer (int32)	Средняя обработка элементов за синхронизацию.
averageSynchronizationDuration	string	Средняя продолжительность синхронизации в формате HH:MM:SS.
totalSynchronization	integer (int32)	Общее количество синхронизаций.

KnowledgeSourceStatus

Объект

Представляет состояние и историю синхронизации источника знаний.

Имя	Тип	Описание
currentSynchronizationState	SynchronizationState	Текущее состояние синхронизации, охватывающее несколько запусков индексатора.
lastSynchronizationState	CompletedSynchronizationState	Подробная информация о последней завершенной синхронизации. Null при первой синхронизации.
statistics	KnowledgeSourceStatistics	Статистическая информация об истории синхронизации источника знаний. Null при первой синхронизации.
synchronizationInterval	string	Интервал синхронизации (например, '1d' для ежедневного). Null, если расписание не настроено.
synchronizationStatus	KnowledgeSourceSynchronizationStatus	Текущий статус синхронизации.

KnowledgeSourceSynchronizationStatus

Перечисление

Текущее состояние синхронизации источника знаний.

Значение	Описание
creating	Источник знаний подготавливается.
active	Источник знаний активен, и выполняются сеансы синхронизации.
deleting	Источник знаний удаляется, а синхронизация приостанавливается.

SynchronizationState

Объект

Представляет текущее состояние текущей синхронизации, охватывающей несколько запусков индексатора.

Имя	Тип	Описание
itemsSkipped	integer (int32)	Количество элементов, пропущенных в текущей синхронизации.
itemsUpdatesFailed	integer (int32)	Количество обновлений элементов, которые завершились сбоем в текущей синхронизации.
itemsUpdatesProcessed	integer (int32)	Количество обновлений элементов, успешно обработанных в текущей синхронизации.
startTime	string (date-time)	Время начала текущей синхронизации.