Indexes - Get Statistics

Возвращает статистику для заданного индекса, включая количество документов и использование хранилища.

GET {endpoint}/indexes('{indexName}')/search.stats?api-version=2024-03-01-Preview

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string	URL-адрес конечной точки службы поиска.
indexName	path	True	string	Имя индекса, для которого требуется получить статистику.
api-version	query	True	string	Версия клиентского API.

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

Имя	Тип	Описание
200 OK	GetIndexStatisticsResult
Other Status Codes	ErrorResponse	Ответ на ошибку.

GET https://myservice.search.windows.net/indexes('hotels')/search.stats?api-version=2024-03-01-Preview

{
  "documentCount": 239572,
  "storageSize": 72375920,
  "vectorIndexSize": 123456
}

Имя	Описание
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
GetIndexStatisticsResult	Статистика по заданному индексу. Статистика собирается периодически и не гарантируется всегда быть up-to-date.

Объект

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

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

Объект

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

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

Объект

Ответ на ошибку

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

Объект

Статистика по заданному индексу. Статистика собирается периодически и не гарантируется всегда быть up-to-date.

Имя	Тип	Описание
documentCount	integer (int64)	Количество документов в индексе.
storageSize	integer (int64)	Объем хранилища в байтах, потребляемых индексом.
vectorIndexSize	integer (int64)	Объем памяти в байтах, потребляемых векторами в индексе.