Aliases - Get

Layanan:: Search Service

Versi API:: 2023-10-01-Preview

Mengambil definisi alias.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
aliasName	path	True	string	Nama alias yang akan diambil.
endpoint	path	True	string	URL titik akhir layanan pencarian.
api-version	query	True	string	Versi Api Klien.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
x-ms-client-request-id		string (uuid)	ID pelacakan yang dikirim dengan permintaan untuk membantu penelusuran kesalahan.

Respons

Nama	Jenis	Deskripsi
200 OK	SearchAlias
Other Status Codes	SearchError	Respons kesalahan.

Contoh

SearchServiceGetAlias

Permintaan sampel

HTTP

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

Respon sampel

Kode status:: 200

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

Definisi

Nama	Deskripsi
SearchAlias	Mewakili alias indeks, yang menjelaskan pemetaan dari nama alias ke indeks. Nama alias dapat digunakan sebagai pengganti nama indeks untuk operasi yang didukung.
SearchError	Menjelaskan kondisi kesalahan untuk API.

SearchAlias

Objek

Mewakili alias indeks, yang menjelaskan pemetaan dari nama alias ke indeks. Nama alias dapat digunakan sebagai pengganti nama indeks untuk operasi yang didukung.

Nama	Jenis	Deskripsi
@odata.etag	string	ETag alias.
indexes	string[]	Nama indeks yang dipetakan alias ini. Hanya satu nama indeks yang dapat ditentukan.
name	string	Nama alias.

SearchError

Objek

Menjelaskan kondisi kesalahan untuk API.

Nama	Jenis	Deskripsi
code	string	Salah satu sekumpulan kode kesalahan yang ditentukan server.
details	SearchError[]	Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini.
message	string	Representasi kesalahan yang dapat dibaca manusia.