Aliases - Get

Referenz

Dienst:: Search Service

API-Version:: 2023-10-01-Preview

Ruft eine Aliasdefinition ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
aliasName	path	True	string	Der Name des abzurufenden Alias.
endpoint	path	True	string	Die Endpunkt-URL des Suchdiensts.
api-version	query	True	string	Client-API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-request-id		string uuid	Die Verfolgungs-ID, die mit der Anforderung gesendet wurde, um beim Debuggen zu helfen.

Antworten

Name	Typ	Beschreibung
200 OK	SearchAlias
Other Status Codes	SearchError	Fehlerantwort.

Beispiele

SearchServiceGetAlias

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

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

Definitionen

Name	Beschreibung
SearchAlias	Stellt einen Indexalias dar, der eine Zuordnung vom Aliasnamen zu einem Index beschreibt. Der Aliasname kann anstelle des Indexnamens für unterstützte Vorgänge verwendet werden.
SearchError	Beschreibt eine Fehlerbedingung für die API.

SearchAlias

Stellt einen Indexalias dar, der eine Zuordnung vom Aliasnamen zu einem Index beschreibt. Der Aliasname kann anstelle des Indexnamens für unterstützte Vorgänge verwendet werden.

Name	Typ	Beschreibung
@odata.etag	string	Das ETag des Alias.
indexes	string[]	Der Name des Indexes, dem dieser Alias zugeordnet ist. Es kann nur ein Indexname angegeben werden.
name	string	Der Name des Alias.

SearchError

Beschreibt eine Fehlerbedingung für die API.

Name	Typ	Beschreibung
code	string	Einer von einem serverdefiniertem Satz von Fehlercodes.
details	SearchError[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
message	string	Eine lesbare Darstellung des Fehlers.

Freigeben über