Tworzenie lub aktualizowanie aliasu (interfejs API REST w wersji zapoznawczej)
Dotyczy: 2023-07-01-Preview, 2021-04-30-Preview
Ważne
2023-07-01-Preview (brak zmian).
2021-04-30-Preview dodaje interfejs API.
W usłudze Azure AI Search alias to nazwa pomocnicza, która może służyć do odwoływania się do indeksu do wykonywania zapytań, indeksowania i innych operacji.
Możesz użyć metody POST lub PUT w żądaniu tworzenia. W przypadku jednej z nich dokument JSON w treści żądania zawiera definicję obiektu.
POST https://[service name].search.windows.net/aliases?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
W przypadku żądań aktualizacji użyj polecenia PUT i określ nazwę aliasu w identyfikatorze URI.
PUT https://[service name].search.windows.net/aliases/[alias name]?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
Protokół HTTPS jest wymagany dla wszystkich żądań obsługi. W przypadku funkcji PUT, jeśli alias nie istnieje, zostanie utworzony. Jeśli już istnieje, zostanie ona zaktualizowana do nowej definicji.
Tworzenie aliasu ustanawia mapowanie między nazwą aliasu a nazwą indeksu. Jeśli żądanie zakończy się pomyślnie, alias może służyć do indeksowania, wykonywania zapytań i innych operacji.
Aktualizacja aliasu umożliwia mapowanie tego aliasu na inny indeks wyszukiwania. Po zaktualizowaniu istniejącego aliasu cała definicja jest zastępowana zawartością treści żądania. Ogólnie rzecz biorąc, najlepszym wzorcem do użycia w przypadku aktualizacji jest pobranie definicji aliasu za pomocą polecenia GET, zmodyfikowanie go, a następnie zaktualizowanie za pomocą funkcji PUT.
Uwaga
Propagacja aktualizacji aliasu w systemie może potrwać do 10 sekund, dlatego przed usunięciem indeksu, do którego wcześniej został zamapowany alias, należy poczekać co najmniej 10 sekund.
Uwaga
Maksymalna liczba aliasów, które można utworzyć, różni się w zależności od warstwy cenowej. Aby uzyskać więcej informacji, zobacz Limity usługi.
Parametry identyfikatora URI
| Parametr | Opis |
|---|---|
| nazwa usługi | Wymagane. Ustaw tę wartość na unikatową, zdefiniowaną przez użytkownika nazwę usługi wyszukiwania. |
| nazwa aliasu | Wymagane dla identyfikatora URI w przypadku używania funkcji PUT. Nazwa musi mieć małe litery, zaczynać się literą lub cyfrą, nie ma ukośników ani kropek i ma mniej niż 128 znaków. Po rozpoczęciu nazwy literą lub cyfrą reszta nazwy może zawierać dowolną literę, cyfrę i kreski, o ile kreski nie są kolejne. |
| api-version | Wymagane. Bieżąca wersja zapoznawcza to 2023-07-01-Preview. Zobacz Wersje interfejsu API , aby uzyskać więcej wersji. |
Nagłówki żądań
W poniższej tabeli opisano wymagane i opcjonalne nagłówki żądań.
| Pola | Opis |
|---|---|
| Content-Type | Wymagane. Ustaw tę wartość na application/json |
| api-key | Opcjonalnie, jeśli używasz ról platformy Azure , a token elementu nośnego jest dostarczany w żądaniu, w przeciwnym razie wymagany jest klucz. Api-key to unikatowy ciąg generowany przez system, który uwierzytelnia żądanie w usłudze wyszukiwania. Tworzenie żądań musi zawierać api-key nagłówek ustawiony na klucz administratora (w przeciwieństwie do klucza zapytania). Aby uzyskać szczegółowe informacje, zobacz Nawiązywanie połączenia z usługą Azure AI Search przy użyciu uwierzytelniania klucza . |
Treść żądania
Treść żądania zawiera definicję aliasu, która zawiera nazwę aliasu i tablicę o nazwie pojedynczego indeksu.
Poniższy kod JSON jest ogólną reprezentacją głównych części definicji.
{
"name" : (optional on PUT; required on POST) "The name of the alias",
"indexes" : (required) ["The name of the index the alias is mapped to"]
}
Żądanie zawiera następujące właściwości:
| Właściwość | Opis |
|---|---|
| name | Wymagane. Nazwa aliasu. Nazwa aliasu musi zawierać tylko małe litery, cyfry lub kreski, nie może zaczynać ani kończyć się kreskami i jest ograniczona do 128 znaków. |
| Indeksy | Wymagane. Nazwa indeksu, na który jest mapowany alias. Tablica może zawierać tylko jedną nazwę indeksu. |
Reakcja
W przypadku pomyślnego utworzenia żądania powinien zostać wyświetlony kod stanu "201 Utworzony".
W przypadku pomyślnego żądania aktualizacji powinien zostać wyświetlony komunikat "204 Brak zawartości".
Przykłady
Przykład: alias indeksu
{
"name" : "my-alias",
"indexes" : ["my-index"]
}