Indexes - Get Statistics

  • Ссылка
Service:
Search Service
API Version:
2023-11-01

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

GET {endpoint}/indexes('{indexName}')/search.stats?api-version=2023-11-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

SearchError

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

Примеры

SearchServiceGetIndexStatistics

Sample Request

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

Sample Response

Status code:
200 
{
  "documentCount": 239572,
  "storageSize": 72375920,
  "vectorIndexSize": 123456
}

Определения

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

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

Описывает условие ошибки для API.

GetIndexStatisticsResult

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

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

integer

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

integer

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

integer

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

SearchError

Описывает условие ошибки для API.

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

string

Один из серверных наборов кодов ошибок.
details

SearchError[]

Массив сведений о конкретных ошибках, которые привели к этой сообщаемой ошибке.
message

string

Понятное представление ошибки.