Aliases - Create Or Update

Referens

Tjänst:: Search Service

API-version:: 2023-10-01-Preview

Skapar ett nytt sökalias eller uppdaterar ett alias om det redan finns.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
aliasName	path	True	string	Definitionen av aliaset som ska skapas eller uppdateras.
endpoint	path	True	string	Slutpunkts-URL:en för söktjänsten.
api-version	query	True	string	Klient-API-version.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-request-id		string uuid	Spårnings-ID:t som skickas med begäran för att hjälpa till med felsökning.
If-Match		string	Definierar villkoret If-Match. Åtgärden utförs endast om ETag på servern matchar det här värdet.
If-None-Match		string	Definierar villkoret If-None-Match. Åtgärden utförs endast om ETag på servern inte matchar det här värdet.
Prefer	True	string	För HTTP PUT-begäranden instruerar tjänsten att returnera den skapade/uppdaterade resursen när den lyckas.

Begärandetext

Name	Obligatorisk	Typ	Description
indexes	True	string[]	Namnet på det index som aliaset mappar till. Endast ett indexnamn kan anges.
name	True	string	Namnet på aliaset.
@odata.etag		string	ETag för aliaset.

Svar

Name	Typ	Description
200 OK	SearchAlias
201 Created	SearchAlias
Other Status Codes	SearchError	Felsvar.

Exempel

SearchServiceCreateOrUpdateAlias

Exempelbegäran

HTTP

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


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

Exempelsvar

Statuskod:: 200

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

Statuskod:: 201

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

Definitioner

Name	Description
SearchAlias	Representerar ett indexalias som beskriver en mappning från aliasnamnet till ett index. Aliasnamnet kan användas i stället för indexnamnet för åtgärder som stöds.
SearchError	Beskriver ett felvillkor för API:et.

SearchAlias

Representerar ett indexalias som beskriver en mappning från aliasnamnet till ett index. Aliasnamnet kan användas i stället för indexnamnet för åtgärder som stöds.

Name	Typ	Description
@odata.etag	string	ETag för aliaset.
indexes	string[]	Namnet på det index som aliaset mappar till. Endast ett indexnamn kan anges.
name	string	Namnet på aliaset.

SearchError

Beskriver ett felvillkor för API:et.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	SearchError[]	En matris med information om specifika fel som ledde till det rapporterade felet.
message	string	En mänsklig läsbar representation av felet.

Dela via