Aliases - List

Служба:: Search Service

Версия API:: 2026-04-01

Выводит список всех псевдонимов, доступных для службы поиска.

GET {endpoint}/aliases?api-version=2026-04-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)	URL-адрес конечной точки службы поиска.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Заголовок запроса

Имя	Обязательно	Тип	Описание
Accept		Accept	Заголовок Accept.
x-ms-client-request-id		string (uuid)	Непрозрачный, глобально уникальный, созданный клиентом идентификатор строки для запроса.

Ответы

Имя	Тип	Описание
200 OK	ListAliasesResult	Запрос выполнен успешно.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

api-key

Тип: apiKey
В: header

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Области

Имя	Описание
https://search.azure.com/.default

Примеры

SearchServiceListAliases

Образец запроса

HTTP

GET https://exampleservice.search.windows.net/aliases?api-version=2026-04-01

Пример ответа

Код состояния:: 200

{
  "value": [
    {
      "name": "myalias",
      "indexes": [
        "example-index"
      ]
    }
  ]
}

Определения

Имя	Описание
Accept	Заголовок Accept.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).
ListAliasesResult	Ответ на запрос List Aliases. В случае успеха он включает связанные сопоставления индексов для всех псевдонимов.
SearchAlias	Представляет псевдоним индекса, описывающий сопоставление с именем псевдонима с индексом. Имя псевдонима можно использовать вместо имени индекса для поддерживаемых операций.

Accept

Перечисление

Заголовок Accept.

Значение	Описание
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Объект

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info		Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Объект

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Объект

Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

ListAliasesResult

Объект

Ответ на запрос List Aliases. В случае успеха он включает связанные сопоставления индексов для всех псевдонимов.

Имя	Тип	Описание
value	SearchAlias[]	Псевдонимы в службе поиска.

SearchAlias

Объект

Представляет псевдоним индекса, описывающий сопоставление с именем псевдонима с индексом. Имя псевдонима можно использовать вместо имени индекса для поддерживаемых операций.

Имя	Тип	Описание
@odata.etag	string	ETag псевдонима.
indexes	string[]	Имя индекса, с которым сопоставляется этот псевдоним. Может быть указано только одно имя индекса.
name	string	Имя псевдонима.