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)	Идентификатор отслеживания, отправляемый запросом на отладку.

Ответы

Имя	Тип	Описание
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[]	Имя индекса, с помощью этого псевдонима. Можно указать только одно имя индекса.
name	string	Имя псевдонима.

SearchError

Объект

Описывает условие ошибки для API.

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
details	SearchError[]	Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
message	string	Читаемое пользователем представление ошибки.