Aliases - List

Tjänst:: Search Service

API-version:: 2026-04-01

Visar en lista över alla alias som är tillgängliga för en söktjänst.

GET {endpoint}/aliases?api-version=2026-04-01

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string (uri)	Slutpunkts-URL:en för söktjänsten.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-request-id		string (uuid)	En ogenomskinlig, globalt unik, klientgenererad strängidentifierare för begäran.
Accept		Accept	Acceptera-rubriken.

Svar

Name	Typ	Description
200 OK	ListAliasesResult	Begäran har slutförts.
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

api-key

Typ: apiKey
I: header

OAuth2Auth

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Omfattningar

Name	Description
https://search.azure.com/.default

Exempel

SearchServiceListAliases

Exempelbegäran

HTTP

GET https://exampleservice.search.windows.net/aliases?api-version=2026-04-01

Exempelsvar

Statuskod:: 200

{
  "value": [
    {
      "name": "myalias",
      "indexes": [
        "example-index"
      ]
    }
  ]
}

Definitioner

Name	Description
Accept	Acceptera-rubriken.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).
ListAliasesResult	Svar från en begäran om listalias. Om det lyckas innehåller den associerade indexmappningar för alla alias.
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.

Accept

Uppräkning

Acceptera-rubriken.

Värde	Description
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info		Den ytterligare informationen.
type	string	Typen av ytterligare information.

ErrorDetail

Objekt

Felinformationen.

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

ErrorResponse

Objekt

Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).

Name	Typ	Description
error	ErrorDetail	Felet objektet.

ListAliasesResult

Objekt

Svar från en begäran om listalias. Om det lyckas innehåller den associerade indexmappningar för alla alias.

Name	Typ	Description
value	SearchAlias[]	Aliserna i Search-tjänsten.

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