Aliases - Create Or Update

Usługa:: Search Service

Wersja interfejsu API:: 2024-03-01-Preview

Tworzy nowy alias wyszukiwania lub aktualizuje alias, jeśli już istnieje.

PUT {endpoint}/aliases('{aliasName}')?api-version=2024-03-01-Preview

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
aliasName	path	True	string	Definicja aliasu do utworzenia lub zaktualizowania.
endpoint	path	True	string	Adres URL punktu końcowego usługi wyszukiwania.
api-version	query	True	string	Wersja interfejsu API klienta.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-request-id		string (uuid)	Identyfikator śledzenia wysłany z żądaniem, aby ułatwić debugowanie.
If-Match		string	Definiuje warunek If-Match. Operacja zostanie wykonana tylko wtedy, gdy element ETag na serwerze jest zgodny z tą wartością.
If-None-Match		string	Definiuje warunek If-None-Match. Operacja zostanie wykonana tylko wtedy, gdy element ETag na serwerze nie jest zgodny z tą wartością.
Prefer	True	string	W przypadku żądań HTTP PUT nakazuje usłudze zwrócenie utworzonego/zaktualizowanego zasobu w przypadku powodzenia.

Treść żądania

Nazwa	Wymagane	Typ	Opis
indexes	True	string[]	Nazwa indeksu, na który mapuje ten alias. Można określić tylko jedną nazwę indeksu.
name	True	string	Nazwa aliasu.
@odata.etag		string	Element ETag aliasu.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SearchAlias
201 Created	SearchAlias
Other Status Codes	ErrorResponse	Odpowiedź na błąd.

Przykłady

SearchServiceCreateOrUpdateAlias

Przykładowe żądanie

HTTP

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


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

Przykładowa odpowiedź

Kod stanu:: 200

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

Kod stanu:: 201

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

Definicje

Nazwa	Opis
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
SearchAlias	Reprezentuje alias indeksu, który opisuje mapowanie z nazwy aliasu na indeks. Nazwa aliasu może być używana zamiast nazwy indeksu dla obsługiwanych operacji.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

SearchAlias

Objekt

Reprezentuje alias indeksu, który opisuje mapowanie z nazwy aliasu na indeks. Nazwa aliasu może być używana zamiast nazwy indeksu dla obsługiwanych operacji.

Nazwa	Typ	Opis
@odata.etag	string	Element ETag aliasu.
indexes	string[]	Nazwa indeksu, na który mapuje ten alias. Można określić tylko jedną nazwę indeksu.
name	string	Nazwa aliasu.