Aliases - Get

Tjänst:
Search Service
API-version:
2025-11-01-preview

Hämtar en aliasdefinition.

GET {endpoint}/aliases('{aliasName}')?api-version=2025-11-01-preview

URI-parametrar

Name I Obligatorisk Typ Description
aliasName
 path True

string

Namnet på aliaset.
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

SearchAlias

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

SearchServiceGetAlias

Exempelbegäran

GET https://previewexampleservice.search.windows.net/aliases('myalias')?api-version=2025-11-01-preview

Exempelsvar

Statuskod:
200 
{
  "name": "myalias",
  "indexes": [
    "preview-test"
  ]
}

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.).
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

Felet riktas.

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.

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.