Aliases - Get

Tjänst:: Search Service

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

Hämtar en aliasdefinition.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
aliasName	path	True	string	Namnet på aliaset som ska hämtas.
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.

Svar

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

Exempel

SearchServiceGetAlias

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 200

{
  "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

Objekt

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	Aliasets ETag.
indexes	string[]	Namnet på det index som aliaset mappar till. Endast ett indexnamn kan anges.
name	string	Namnet på aliaset.

SearchError

Objekt

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.