Aliases - Get
エイリアス定義を取得します。
GET {endpoint}/aliases('{aliasName}')?api-version=2024-03-01-PreviewURI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
alias
|
path | True |
string |
取得するエイリアスの名前。 |
|
endpoint
|
path | True |
string |
検索サービスのエンドポイント URL。 |
|
api-version
|
query | True |
string |
クライアント API のバージョン。 |
要求ヘッダー
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
デバッグに役立つ要求と共に送信される追跡 ID。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK | ||
| Other Status Codes |
エラー応答。 |
例
SearchServiceGetAlias
要求のサンプル
GET https://myservice.search.windows.net/aliases('production')?api-version=2024-03-01-Preview
応答のサンプル
{
"name": "production",
"indexes": [
"hotels"
]
}定義
| 名前 | 説明 |
|---|---|
|
Error |
リソース管理エラーの追加情報。 |
|
Error |
エラーの詳細。 |
|
Error |
エラー応答 |
|
Search |
エイリアス名からインデックスへのマッピングを表すインデックス エイリアスを表します。 エイリアス名は、サポートされている操作のインデックス名の代わりに使用できます。 |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
| 名前 | 型 | 説明 |
|---|---|---|
| info |
object |
追加情報。 |
| type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| additionalInfo |
エラーの追加情報。 |
|
| code |
string |
エラー コード。 |
| details |
エラーの詳細。 |
|
| message |
string |
エラー メッセージ。 |
| target |
string |
エラーターゲット。 |
ErrorResponse
エラー応答
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラー オブジェクト。 |
SearchAlias
エイリアス名からインデックスへのマッピングを表すインデックス エイリアスを表します。 エイリアス名は、サポートされている操作のインデックス名の代わりに使用できます。
| 名前 | 型 | 説明 |
|---|---|---|
| @odata.etag |
string |
エイリアスの ETag。 |
| indexes |
string[] |
このエイリアスがマップされるインデックスの名前。 指定できるインデックス名は 1 つだけです。 |
| name |
string |
エイリアスの名前。 |