Aliases - Get

サービス:

Search Service

API バージョン:

2024-11-01-preview

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

GET {endpoint}/aliases('{aliasName}')?api-version=2024-11-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	ErrorResponse	エラー応答。

例

SearchServiceGetAlias

要求のサンプル

HTTP

GET https://previewexampleservice.search.windows.net/aliases('myalias')?api-version=2024-11-01-preview

応答のサンプル

状態コード:

200

{
  "name": "myalias",
  "indexes": [
    "preview-test"
  ]
}

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
SearchAlias	エイリアス名からインデックスへのマッピングを表すインデックス エイリアスを表します。 エイリアス名は、サポートされている操作のインデックス名の代わりに使用できます。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	エラー オブジェクト。

SearchAlias

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

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