Documents - Count

サービス:

Search Service

API バージョン:

2023-11-01

インデックス内のドキュメントの数を照会します。

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

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string	検索サービスのエンドポイント URL。
indexName	path	True	string	インデックスの名前です。
api-version	query	True	string	クライアント API のバージョン。

要求ヘッダー

名前	必須	型	説明
x-ms-client-request-id		string uuid	デバッグに役立つ要求と共に送信された追跡 ID。

応答

名前	型	説明
200 OK	integer
Other Status Codes	SearchError	エラー応答。

例

SearchIndexCountDocuments

要求のサンプル

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs/$count?api-version=2023-11-01

応答のサンプル

状態コード:

200

427

定義

SearchError

API のエラー条件について説明します。

名前	型	説明
code	string	サーバー定義のエラー コードのセットの 1 つ。
details	SearchError[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
message	string	エラーの人間が判読できる表現。