Vytvoření nebo aktualizace aliasu (rozhraní REST API verze Preview)
Platí pro: 2023-07-01-Preview, 2021-04-30-Preview
Důležité
2023-07-01-Preview (beze změn)
2021-04-30-Preview přidá rozhraní API.
Ve službě Azure AI Search je alias sekundární název, který se dá použít k odkazování na index pro dotazování, indexování a další operace.
U žádosti o vytvoření můžete použít post nebo PUT. U obou z nich dokument JSON v textu požadavku poskytuje definici objektu.
POST https://[service name].search.windows.net/aliases?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
Pro žádosti o aktualizaci použijte PUT a zadejte název aliasu v identifikátoru URI.
PUT https://[service name].search.windows.net/aliases/[alias name]?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
Https se vyžaduje pro všechny žádosti o služby. Pokud v případě PUT alias neexistuje, vytvoří se. Pokud už existuje, aktualizuje se na novou definici.
Vytvoření aliasu vytvoří mapování mezi názvem aliasu a názvem indexu. Pokud je požadavek úspěšný, můžete alias použít k indexování, dotazování a dalším operacím.
Aktualizace aliasu umožňuje namapovat tento alias na jiný index vyhledávání. Při aktualizaci existujícího aliasu se celá definice nahradí obsahem textu požadavku. Obecně platí, že nejlepší způsob, jak použít pro aktualizace, je načíst definici aliasu pomocí get, upravit ji a pak ji aktualizovat pomocí PUT.
Poznámka
Rozšíření aktualizace aliasu v systému může trvat až 10 sekund, takže byste měli před odstraněním indexu, na který byl alias dříve namapován, počkat alespoň 10 sekund.
Poznámka
Maximální počet aliasů, které můžete vytvořit, se liší podle cenové úrovně. Další informace najdete v tématu Limity služeb.
Parametry identifikátoru URI
| Parametr | Popis |
|---|---|
| název služby | Povinná hodnota. Nastavte tuto hodnotu na jedinečný, uživatelem definovaný název vaší vyhledávací služby. |
| název aliasu | Vyžaduje se u identifikátoru URI, pokud používáte PUT. Název musí mít malá písmena, musí začínat písmenem nebo číslicí, nesmí mít lomítka ani tečky a musí být kratší než 128 znaků. Jakmile začnete jméno písmenem nebo číslem, může zbytek názvu obsahovat libovolné písmeno, číslo a pomlčky, pokud pomlčky nejsou po sobě jdoucí. |
| verze-api | Povinná hodnota. Aktuální verze Preview je 2023-07-01-Preview. Další verze najdete v tématu Verze rozhraní API . |
Hlavičky požadavku
Následující tabulka popisuje požadované a volitelné hlavičky požadavků.
| Pole | Description |
|---|---|
| Typ obsahu | Povinná hodnota. Nastavte tuto hodnotu na application/json |
| api-key | Volitelné, pokud používáte role Azure a v požadavku je k dispozici nosný token, jinak se vyžaduje klíč. Klíč api-key je jedinečný systémově vygenerovaný řetězec, který ověřuje požadavek pro vaši vyhledávací službu. Požadavky na vytvoření musí obsahovat hlavičku nastavenou api-key na klíč správce (na rozdíl od klíče dotazu). Podrobnosti najdete v tématu Připojení ke službě Azure AI Search pomocí ověřování pomocí klíče . |
Text požadavku
Tělo požadavku obsahuje definici aliasu, která zahrnuje název aliasu a pole s názvem jednoho indexu.
Následující kód JSON představuje základní reprezentaci hlavních částí definice.
{
"name" : (optional on PUT; required on POST) "The name of the alias",
"indexes" : (required) ["The name of the index the alias is mapped to"]
}
Požadavek obsahuje následující vlastnosti:
| Vlastnost | Popis |
|---|---|
| name | Povinná hodnota. Název aliasu. Název aliasu musí obsahovat pouze malá písmena, číslice nebo pomlčky, nesmí začínat ani končit pomlčkami a je omezený na 128 znaků. |
| Indexy | Povinná hodnota. Název indexu, na který je alias namapován. Do pole může být zahrnut pouze jeden název indexu. |
Odpověď
V případě úspěšného vytvoření žádosti by se měl zobrazit stavový kód 201 Vytvořeno.
V případě úspěšné žádosti o aktualizaci by se měla zobrazit zpráva 204 Bez obsahu.
Příklady
Příklad: Alias indexu
{
"name" : "my-alias",
"indexes" : ["my-index"]
}