エイリアスの作成または更新 (プレビュー REST API)

  • [アーティクル]

API バージョン: 2021-04-30-Preview

重要

API 全体がプレビュー機能です。

Azure Cognitive Search における別名とは、クエリやインデックス作成などの操作でインデックスを参照するときに使用できる第 2 の名前です。

作成要求には POST または PUT を使用できます。 どちらの場合も、要求本文の JSON ドキュメントでオブジェクト定義が提供されます。

POST https://[service name].search.windows.net/aliases?api-version=[api-version]      
  Content-Type: application/json  
  api-key: [admin key]

更新要求の場合は、PUT を使用し、URI のエイリアス名を指定します。

PUT https://[service name].search.windows.net/aliases/[alias name]?api-version=[api-version]  
  Content-Type: application/json  
  api-key: [admin key]

HTTPS はすべてのサービス要求に必要です。 PUT の場合、エイリアスが存在しない場合は作成されます。 既に存在する場合は、新しい定義に更新されます。

エイリアスを作成すると、エイリアス 名とインデックス名の間のマッピングが確立されます。 要求が成功した場合は、インデックス作成、クエリ、その他の操作にエイリアスを使用できます。

エイリアスを更新 すると、そのエイリアスを別の検索インデックスにマップできます。 既存のエイリアスを更新すると、定義全体が要求本文の内容に置き換えられます。 一般に、更新に使用する最適なパターンは、GET を使用してエイリアス定義を取得し、それを変更してから PUT で更新することです。

注意

別名に対する更新がシステムに反映されるまで、最大 10 秒かかるため、その別名が以前マップされていたインデックスを削除するには、10 秒以上お待ちいただく必要があります。

Note

作成できるエイリアスの最大数は、価格レベルによって異なります。 詳細については、サービスの制限に関する記事を参照してください。

URI パラメーター

パラメーター 説明
サービス名 必須です。 これを検索サービスの一意のユーザー定義名に設定します。
エイリアス名 PUT を使用する場合は、URI で必要です。 名前は小文字で、文字または数字で始まり、スラッシュやドットがなく、128 文字未満である必要があります。 文字または数字で名前を開始した後、ダッシュが連続しない限り、名前の残りの部分には任意の文字、数字、ダッシュを含めることができます。
api-version 必須です。 現行バージョンは api-version=2021-04-30-Previewです。 その他 のバージョンについては、API のバージョン を参照してください。

要求ヘッダー

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

フィールド 説明
Content-Type 必須です。 これを application/json
api-key 必須です。 api-key は Search サービスに対する要求の認証に使用されます。 これはサービスに固有の文字列値です。 要求の作成には、(クエリ キーではなく) 管理キーに設定されたヘッダーを含める api-key 必要があります。 API キーは、Azure portalの検索サービス ダッシュボードで確認できます。

要求本文

要求の本文には、エイリアスの名前と 1 つのインデックスの名前を持つ配列を含むエイリアス定義が含まれています。

次の JSON は、定義の主要部分の概要を表しています。

{   
    "name" : (optional on PUT; required on POST) "The name of the alias",  
    "indexes" : (required) ["The name of the index the alias is mapped to"]
}

要求には次のプロパティが含まれます。

プロパティ 説明
name 必須。 エイリアスの名前。 エイリアス名には、小文字、数字、ダッシュのみを含める必要があり、ダッシュで開始または終了することはできません。128 文字に制限されます。
インデックス 必須です。 エイリアスがマップされるインデックスの名前。 配列に含めることができるインデックス名は 1 つだけです。

応答

作成要求が正常に完了すると、状態コード "201 Created" が表示されます。

更新要求が正常に完了すると、"204 コンテンツなし" と表示されます。

例

例: インデックスエイリアス

{   
  "name" : "my-alias",  
  "indexes" : ["my-index"]
}

関連項目