Aliases - Get
Načte definici aliasu.
GET {endpoint}/aliases('{aliasName}')?api-version=2024-09-01-preview
Parametry identifikátoru URI
| Name | V | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
alias
|
path | True |
string |
Název aliasu, který se má načíst. |
|
endpoint
|
path | True |
string |
Adresa URL koncového bodu vyhledávací služby. |
|
api-version
|
query | True |
string |
Verze rozhraní API klienta. |
Hlavička požadavku
| Name | Vyžadováno | Typ | Description |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
ID sledování odeslané s požadavkem, které vám pomůže s laděním. |
Odpovědi
| Name | Typ | Description |
|---|---|---|
| 200 OK | ||
| Other Status Codes |
Chybová odpověď. |
Příklady
SearchServiceGetAlias
Ukázkový požadavek
GET https://previewexampleservice.search.windows.net/aliases('myalias')?api-version=2024-09-01-preview
Ukázková odpověď
{
"name": "myalias",
"indexes": [
"preview-test"
]
}
Definice
| Name | Description |
|---|---|
|
Error |
Další informace o chybě správy prostředků |
|
Error |
Podrobnosti o chybě. |
|
Error |
Chybová odpověď |
|
Search |
Představuje alias indexu, který popisuje mapování z názvu aliasu na index. Název aliasu lze použít místo názvu indexu pro podporované operace. |
ErrorAdditionalInfo
Další informace o chybě správy prostředků
| Name | Typ | Description |
|---|---|---|
| info |
object |
Další informace. |
| type |
string |
Další typ informací. |
ErrorDetail
Podrobnosti o chybě.
| Name | Typ | Description |
|---|---|---|
| additionalInfo |
Další informace o chybě. |
|
| code |
string |
Kód chyby. |
| details |
Podrobnosti o chybě. |
|
| message |
string |
Chybová zpráva. |
| target |
string |
Cíl chyby. |
ErrorResponse
Chybová odpověď
| Name | Typ | Description |
|---|---|---|
| error |
Objekt chyby. |
SearchAlias
Představuje alias indexu, který popisuje mapování z názvu aliasu na index. Název aliasu lze použít místo názvu indexu pro podporované operace.
| Name | Typ | Description |
|---|---|---|
| @odata.etag |
string |
ETag aliasu. |
| indexes |
string[] |
Název indexu, na který se tento alias mapuje. Je možné zadat pouze jeden název indexu. |
| name |
string |
Název aliasu. |