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

Ответы

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

Поделиться через