Aliases - Create Or Update

Ссылка

Служба:: Search Service

Версия API:: 2023-10-01-Preview

Создает новый псевдоним поиска или обновляет псевдоним, если он уже существует.

PUT {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	Идентификатор отслеживания, отправленный с запросом на помощь в отладке.
If-Match		string	Определяет условие If-Match. Операция будет выполняться только в том случае, если ETag на сервере соответствует этому значению.
If-None-Match		string	Определяет условие If-None-Match. Операция будет выполняться только в том случае, если ETag на сервере не соответствует этому значению.
Prefer	True	string	Для HTTP-запросов PUT указывает службе вернуть созданный или обновленный ресурс при успешном выполнении.

Текст запроса

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

Ответы

Имя	Тип	Описание
200 OK	SearchAlias
201 Created	SearchAlias
Other Status Codes	SearchError	Ответ об ошибке.

Примеры

SearchServiceCreateOrUpdateAlias

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

HTTP

PUT https://myservice.search.windows.net/aliases('production')?api-version=2023-10-01-Preview


{
  "name": "production",
  "indexes": [
    "hotels"
  ]
}

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

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

{
  "name": "production",
  "indexes": [
    "hotels"
  ]
}

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

{
  "name": "production",
  "indexes": [
    "hotels"
  ]
}

Определения

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

SearchAlias

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

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

SearchError

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

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

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