Aliases - Get

Referens

Tjänst:: Search Service

API-version:: 2024-05-01-preview

Hämtar en aliasdefinition.

GET {endpoint}/aliases('{aliasName}')?api-version=2024-05-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	ErrorResponse	Felsvar.

Exempel

SearchServiceGetAlias

Exempelbegäran

HTTP

GET https://myservice.search.windows.net/aliases('production')?api-version=2024-05-01-preview

Exempelsvar

Statuskod:: 200

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

Definitioner

Name	Description
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
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.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Den ytterligare informationstypen.

ErrorDetail

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

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

Dela via