Indexes - Get Statistics

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

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

Параметры 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

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

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

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

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

Определения

Имя Описание
ErrorAdditionalInfo

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

ErrorDetail

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

ErrorResponse

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

GetIndexStatisticsResult

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

ErrorAdditionalInfo

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

Имя Тип Описание
info

object

Дополнительные сведения.

type

string

Дополнительный тип сведений.

ErrorDetail

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

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

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

code

string

Код ошибки.

details

ErrorDetail[]

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

message

string

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

target

string

Целевой объект ошибки.

ErrorResponse

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

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

GetIndexStatisticsResult

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

Имя Тип Описание
documentCount

integer

Количество документов в индексе.

storageSize

integer

Объем хранилища в байтах, потребляемых индексом.

vectorIndexSize

integer

Объем памяти в байтах, потребляемых векторами в индексе.