Indexes - Get Statistics

Служба:

Search Service

Версия API:

2024-05-01-preview

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

GET {endpoint}/indexes('{indexName}')/search.stats?api-version=2024-05-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	Ответ об ошибке.

Примеры

SearchServiceGetIndexStatistics

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

HTTP

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

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

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

200

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

Определения

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

ErrorAdditionalInfo

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

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

ErrorDetail

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

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

ErrorResponse

Сообщение об ошибке

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

GetIndexStatisticsResult

Статистика по заданному индексу. Статистика собирается периодически и не всегда будет актуальной.

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