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
フロー: implicit
Authorization URL (承認 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	すべてのAzure Resource Manager APIで失敗した操作に対してエラー詳細を返す共通のエラー応答です。 (これは、OData エラー応答形式にも従います)。

Accept

列挙

Acceptヘッダーです。

値	説明
application/json;odata.metadata=none

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info		追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

すべてのAzure Resource Manager APIで失敗した操作に対してエラー詳細を返す共通のエラー応答です。 (これは、OData エラー応答形式にも従います)。

名前	型	説明
error	ErrorDetail	エラーオブジェクト。