インデックスの取得 (Azure AI Search REST API)
インデックスの取得操作は、Azure AI Search からインデックス定義を取得します。
GET https://[service name].search.windows.net/indexes/[index name]?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
URI パラメーター
| パラメーター | 説明 |
|---|---|
| サービス名 | 必須。 これを検索サービスの一意のユーザー定義名に設定します。 |
| インデックス名 | 必須。 要求 URI は、返すインデックスの名前を指定します。 |
| api-version | 必須。 サポートされている バージョンの 一覧については、「API のバージョン」を参照してください。 |
要求ヘッダー
次の表では、必須と省略可能の要求ヘッダーについて説明します。
| フィールド | 説明 |
|---|---|
| Content-Type | 必須。 これを application/json |
| api-key | Azure ロールを使用していて、要求でベアラー トークンが提供されている場合は省略可能。それ以外の場合はキーが必要です。 API キーを使用している場合は、(クエリ キーではなく) 管理キーを指定して、検索サービスからオブジェクト情報を返します。 詳細については、「 キー認証を使用して Azure AI Search に接続 する」を参照してください。 |
要求本文
[なし] :
Response
状態コード: 正常な応答のために "200 OK" が返されます。 応答ペイロードの例については、「 インデックスの作成 (Azure AI Search REST API)」 の要求 JSON の例を参照してください。 インデックスの取得応答本文とインデックスの作成応答と応答本文はすべて同じ形式です。