Documents - Count

Служба:: Search Service

Версия API:: 2026-04-01

Запрашивает количество документов в индексе.

GET {endpoint}/indexes('{indexName}')/docs/$count?api-version=2026-04-01

Параметры URI

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

Заголовок запроса

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

Ответы

Имя	Тип	Описание
200 OK	integer	Запрос выполнен успешно. Media Types: "text/plain; charset=utf-8", "application/json"
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке. Media Types: "text/plain; charset=utf-8", "application/json"

Имя

Тип

Описание

200 OK

integer

Запрос выполнен успешно.

Media Types: "text/plain; charset=utf-8", "application/json"

Other Status Codes

ErrorResponse

Непредвиденное сообщение об ошибке.

Media Types: "text/plain; charset=utf-8", "application/json"

Безопасность

api-key

Тип: apiKey
В: header

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Области

Имя	Описание
https://search.azure.com/.default

Примеры

SearchIndexCountDocuments

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

HTTP

GET https://exampleservice.search.windows.net/indexes('example-index')/docs/$count?api-version=2026-04-01

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

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

Определения

Имя	Описание
Accept	Заголовок Accept.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).

Accept

Перечисление

Заголовок Accept.

Значение	Описание
application/json;odata.metadata=none

ErrorAdditionalInfo

Объект

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

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

ErrorDetail

Объект

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

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

ErrorResponse

Объект

Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).

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