Documents - Count

Serviço:: Search Service

Versão da API:: 2026-05-01-preview

Consulta o número de documentos no índice.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string (uri)	A URL do ponto de extremidade do serviço de pesquisa.
indexName	path	True	string	O nome do índice.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Accept		Accept	O cabeçalho Aceitar.
x-ms-client-request-id		string (uuid)	Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Respostas

Name	Tipo	Description
200 OK	integer	O pedido foi bem-sucedido. Media Types: "text/plain; charset=utf-8", "application/json"
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada. Media Types: "text/plain; charset=utf-8", "application/json"

Name

Tipo

Description

200 OK

integer

O pedido foi bem-sucedido.

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

Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

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

Segurança

api-key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Âmbitos

Name	Description
https://search.azure.com/.default

Exemplos

SearchIndexCountDocuments

Pedido de amostra

HTTP

GET https://previewexampleservice.search.windows.net/indexes('preview-test')/docs/$count?api-version=2026-05-01-preview

Resposta da amostra

Código de estado:: 200

Definições

Name	Description
Accept	O cabeçalho Aceitar.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.)

Accept

Enumeração

O cabeçalho Aceitar.

Valor	Description
application/json;odata.metadata=none

ErrorAdditionalInfo

Object

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info		As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O alvo do erro.

ErrorResponse

Object

Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.)

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.