Documents - Count

服務:: Search Service

API 版本:: 2026-08-01-preview

查詢索引中的文件數目。

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

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string (uri)	搜尋服務的端點 URL。
indexName	path	True	string	索引的名稱。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

要求標頭

名稱	必要	類型	Description
Accept		Accept	接受標頭。
x-ms-client-request-id		string (uuid)	要求不透明、全域唯一、用戶端產生的字串標識碼。

回應

名稱	類型	Description
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"

名稱

類型

Description

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

範圍

名稱	Description
https://search.azure.com/.default

範例

SearchIndexCountDocuments

範例要求

HTTP

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

範例回覆

狀態碼:: 200

定義

名稱	Description
Accept	接受標頭。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細資料。
ErrorResponse	所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。（這也遵循 OData 錯誤回應格式。）。

Accept

列舉型別

接受標頭。

值	Description
application/json;odata.metadata=none

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info		其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細資料。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤的其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳情
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。（這也遵循 OData 錯誤回應格式。）。

名稱	類型	Description
error	ErrorDetail	error 物件。