ドキュメントのカウント (Azure Cognitive Search REST API)

Count documents 操作は、検索インデックス内のドキュメントの数を取得します。 $count 構文は、OData プロトコルの一部です。

GET https://[service name].search.windows.net/indexes/[index name]/docs/$count?api-version=[api-version]  
  Content-Type: application/json   
  api-key: [admin or query key]    

URI パラメーター

パラメーター 説明
サービス名 必須。 これを、検索サービスの一意のユーザー定義名に設定します。
インデックス名 必須。 要求 URI 内の [index name] は、指定したインデックスのドキュメント コレクション内のすべてのアイテムの数を返すようにサービスに指示します。
api-version 必須。 現在の安定バージョンは api-version=2020-06-30 です。 詳細については、「 API バージョン 」を参照してください。

要求ヘッダー

次の表では、必須と省略可能の要求ヘッダーについて説明します。

フィールド 説明
Content-Type 必須。 これを application/json
api-key 必須。 Api キーは、Search サービスへの要求を認証するために使用されます。 これはサービスに固有の文字列値です。 Count Documents 要求では、の管理者キーまたはクエリキーのいずれかを指定でき api-key ます。

Api キーの値は、Azure portal のサービスダッシュボードから取得できます。 詳細については、「 既存のキーを検索する」を参照してください。

要求本文

[なし] :

Response

状態コード: 応答の成功に対して「200 OK」が返されます。

応答本文には、プレーン テキスト形式の整数として、カウント値が含まれます。

関連項目

Azure Cognitive Search REST API
HTTP 状態コード
Azure Cognitive Search の OData 式の構文
検索結果ページ