Aliases - Get

サービス:

Search Service

API バージョン:

2023-10-01-Preview

エイリアス定義を取得します。

GET {endpoint}/aliases('{aliasName}')?api-version=2023-10-01-Preview

URI パラメーター

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

要求ヘッダー

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

応答

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

例

SearchServiceGetAlias

要求のサンプル

HTTP

GET https://myservice.search.windows.net/aliases('production')?api-version=2023-10-01-Preview

応答のサンプル

状態コード:

200

{
  "name": "production",
  "indexes": [
    "hotels"
  ]
}

定義

名前	説明
SearchAlias	エイリアス名からインデックスへのマッピングを記述するインデックス エイリアスを表します。 エイリアス名は、サポートされている操作のインデックス名の代わりに使用できます。
SearchError	API のエラー条件について説明します。

SearchAlias

エイリアス名からインデックスへのマッピングを記述するインデックス エイリアスを表します。 エイリアス名は、サポートされている操作のインデックス名の代わりに使用できます。

名前	型	説明
@odata.etag	string	エイリアスの ETag。
indexes	string[]	このエイリアスがマップされるインデックスの名前。 指定できるインデックス名は 1 つだけです。
name	string	エイリアスの名前。

SearchError

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

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