Skapa eller uppdatera alias (förhandsversion av REST API)
Gäller för: 2023-07-01-Preview, 2021-04-30-Preview
Viktigt
2023-07-01-Preview (inga ändringar).
2021-04-30-Preview lägger till API:et.
I Azure AI Search är ett alias ett sekundärt namn som kan användas för att referera till ett index för frågor, indexering och andra åtgärder.
Du kan använda post eller PUT på en create-begäran. JSON-dokumentet i begärandetexten innehåller objektdefinitionen för båda.
POST https://[service name].search.windows.net/aliases?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
För uppdateringsbegäranden använder du PUT och anger aliasnamnet på URI:n.
PUT https://[service name].search.windows.net/aliases/[alias name]?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
HTTPS krävs för alla tjänstbegäranden. När det gäller PUT skapas aliaset om det inte finns. Om den redan finns uppdateras den till den nya definitionen.
När du skapar ett alias upprättas en mappning mellan ett aliasnamn och ett indexnamn. Om begäran lyckas kan aliaset användas för indexering, frågor och andra åtgärder.
Genom att uppdatera ett alias kan du mappa aliaset till ett annat sökindex. När du uppdaterar ett befintligt alias ersätts hela definitionen med innehållet i begärandetexten. I allmänhet är det bästa mönstret att använda för uppdateringar att hämta aliasdefinitionen med en GET, ändra den och sedan uppdatera den med PUT.
Anteckning
En uppdatering av ett alias kan ta upp till 10 sekunder att spridas genom systemet, så du bör vänta minst 10 sekunder innan du tar bort indexet som aliaset tidigare har mappats till.
Anteckning
Det maximala antalet alias som du kan skapa varierar beroende på prisnivå. Mer information finns i Tjänstbegränsningar.
URI-parametrar
| Parameter | Beskrivning |
|---|---|
| tjänstnamn | Krävs. Ange det här värdet till det unika, användardefinierade namnet på söktjänsten. |
| aliasnamn | Krävs på URI:n om du använder PUT. Namnet måste vara gemener, börja med en bokstav eller siffra, ha inga snedstreck eller punkter och vara färre än 128 tecken. När du har börjat namnet med en bokstav eller siffra kan resten av namnet innehålla valfri bokstav, siffra och bindestreck, så länge bindestrecken inte är i följd. |
| api-version | Krävs. Den aktuella förhandsversionen är 2023-07-01-Preview. Fler versioner finns i API-versioner . |
Rubriker för begäran
I följande tabell beskrivs de obligatoriska och valfria begärandehuvudena.
| Fält | Description |
|---|---|
| Content-Type | Krävs. Ange det här värdet till application/json |
| api-key | Valfritt om du använder Azure-roller och en ägartoken anges i begäran, annars krävs en nyckel. En API-nyckel är en unik, systemgenererad sträng som autentiserar begäran till söktjänsten. Skapa begäranden måste innehålla en api-key rubrik som är inställd på din administratörsnyckel (till skillnad från en frågenyckel). Mer information finns i Ansluta till Azure AI Search med nyckelautentisering . |
Begärandetext
Brödtexten i begäran innehåller en aliasdefinition, som innehåller namnet på ett alias och en matris med namnet på ett enda index.
Följande JSON är en övergripande representation av de viktigaste delarna i definitionen.
{
"name" : (optional on PUT; required on POST) "The name of the alias",
"indexes" : (required) ["The name of the index the alias is mapped to"]
}
Begäran innehåller följande egenskaper:
| Egenskap | Beskrivning |
|---|---|
| name | Krävs. Namnet på aliaset. Ett aliasnamn får bara innehålla gemener, siffror eller bindestreck, får inte börja eller sluta med bindestreck och får innehålla högst 128 tecken. |
| Index | Krävs. Namnet på indexet som aliaset mappas till. Endast ett enda indexnamn kan ingå i matrisen. |
Svarsåtgärder
För en lyckad begäran om att skapa bör du se statuskoden "201 Skapad".
För en lyckad uppdateringsbegäran bör du se "204 Inget innehåll".
Exempel
Exempel: Ett indexalias
{
"name" : "my-alias",
"indexes" : ["my-index"]
}