Получение статистики служб (предварительная версия REST API)
применимо к: 2023-07-01-Preview. Эта версия больше не поддерживается. немедленное обновление до более новой версии.
Важный
2023-07-01-Preview добавляет vectorIndexSize в службу поиска.
2021-04-30-Preview добавляет псевдонимовCount.
Операция service Statistics возвращает количество и тип объектов в службе, максимально допустимое для каждого типа объекта, заданного уровнем служб, фактическим и максимальным хранилищем, а также другими ограничениями, которые зависят от уровня. Этот запрос извлекает сведения из службы, чтобы вам не нужно было искать или вычислять ограничения службы .
Статистика по количеству документов и размеру хранилища собираются каждые несколько минут, а не в режиме реального времени. Поэтому статистика, возвращаемая этим API, может не отражать изменения, вызванные недавними операциями индексирования.
GET https://[service name].search.windows.net/servicestats?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
Параметры URI
| Параметр | Описание |
|---|---|
| Имя службы | Обязательно. Задайте для этого значения уникальное, определяемое пользователем имя службы поиска. URI запроса указывает имя индекса, для которого должна быть возвращена статистика. |
| версия API | Обязательно. Дополнительные версии API см. в версиях API. |
Заголовки запросов
В следующей таблице описаны обязательные и необязательные заголовки запросов.
| Поля | Описание |
|---|---|
| Тип контента | Обязательно. Задайте для этого значения значение application/json |
| api-key | Необязательно, если вы используете роли Azure и маркер носителя предоставляется в запросе, в противном случае требуется ключ. Ключ API — это уникальная, созданная системой строка, которая проверяет подлинность запроса в службе поиска. Запросы к службе поиска должны содержать заголовок api-key, заданный для ключа администратора (в отличие от ключа запроса). Дополнительные сведения см. в статье Connect to Azure AI Search using key authentication. |
Текст запроса
Никакой.
Ответ
Код состояния: "200 ОК" возвращается для успешного ответа. Текст ответа имеет следующий формат:
{
"counters": {
"documentCount": {
"usage": number,
"quota": number | null (if the service has unlimited document counts, the quota will be null)
},
"indexesCount": {
"usage": number,
"quota": number
},
"indexersCount": {
"usage": number,
"quota": number
},
"dataSourcesCount": {
"usage": number,
"quota": number
},
"storageSize": {
"usage": number (bytes),
"quota": number (bytes)
},
"synonymMaps": {
"usage": number,
"quota": number
},
"aliasesCount": {
"usage": number,
"quota": number
},
"vectorIndexSize": {
"usage": number (bytes),
"quota": number (bytes)
}
},
"limits": {
"maxFieldsPerIndex": number,
"maxIndexerRunTime": string,
"maxFileExtractionSize": number,
"maxFileContentCharactersToExtract": number,
"maxFieldNestingDepthPerIndex": number,
"maxComplexCollectionFieldsPerIndex": number,
"maxComplexObjectsInCollectionsPerDocument": number
}
}
| Статистический | Тип | Описание |
|---|---|---|
| documentCount | Считать | Агрегирование всех документов из всех индексов. Ранние версии службы "Поиск ИИ Azure" применяют ограничения количества документов, но это ограничение больше не существует. Квота всегда имеет значение NULL, указывающее, что служба может иметь неограниченное количество документов. |
| indexesCount | Считать | Количество индексов в службе поиска. Максимальные индексы зависят от уровня, как сообщает квота. |
| indexersCount | Считать | Количество индексаторов в службе поиска. Максимальные индексаторы зависят от уровня, как сообщает квота. |
| dataSourcesCount | Считать | Количество источников данных в службе поиска. Максимальное количество источников данных зависит от уровня, как сообщает квота. Максимальное количество источников данных совпадает с максимальным числом индексаторов. |
| aliasesCount | Считать | Количество псевдонимов индекса в службе поиска. Максимальное значение зависит от уровня, как сообщается квотой. |
| синоним-карты | Считать | Количество сопоставлений синонимов в службе поиска. Максимальное значение зависит от уровня, как сообщается квотой. |
| storageSize | Байт | Использование — это объем хранилища, используемого всеми объектами службы. Квота — это максимальное хранилище, доступное на основе размера и количества секций, настроенных для службы. Квота увеличивается и уменьшается в ответ на количество секций, подготовленных в службе поиска. Размер секции зависит от уровня. |
| vectorIndexSize | Байт | Векторный индекс — это внутренняя структура, один векторный индекс на поле вектора, как определено в индексе поиска. Общее использование сообщается в службе, чтобы отслеживать потребление векторного пространства относительно ограничения векторного индекса службы поиска. Квота зависит от возраста службы поиска, количества секций и размера секций, определенных на уровне. |
Дополнительные сведения обо всех ограничениях см. в ограничениях службы.
Примеры
Этот API — это плоскость данных. Дополнительные сведения о службе, такой как уровень или расположение, см. в REST API управления.
{
"@odata.context": "https://my-search-service.search.windows.net/$metadata#Microsoft.Azure.Search.V2019_05_06.ServiceStatistics",
"counters": {
"documentCount": {
"usage": 5072,
"quota": null
},
"indexesCount": {
"usage": 10,
"quota": 15
},
"indexersCount": {
"usage": 8,
"quota": 15
},
"dataSourcesCount": {
"usage": 9,
"quota": 15
},
"storageSize": {
"usage": 22265221,
"quota": 2147483648
},
"synonymMaps": {
"usage": 0,
"quota": 3
},
"aliasesCount": {
"usage": 7,
"quota": 30
},
"vectorIndexSize": {
"usage": 1342476,
"quota": 1073741824
},
"limits": {
"maxFieldsPerIndex": 1000,
"maxIndexerRunTime": "P1D",
"maxFileExtractionSize": 16777216,
"maxFileContentCharactersToExtract": 65536,
"maxFieldNestingDepthPerIndex": 10,
"maxComplexCollectionFieldsPerIndex": 40,
"maxComplexObjectsInCollectionsPerDocument": 3000
}
}