Aliases - Get

Layanan:: Search Service

Versi API:: 2025-08-01-preview

Mengambil definisi alias.

GET {endpoint}/aliases('{aliasName}')?api-version=2025-08-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	ErrorResponse	Respons kesalahan.

Contoh

SearchServiceGetAlias

Permintaan sampel

HTTP

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

Respon sampel

Kode status:: 200

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

Definisi

Nama	Deskripsi
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Tanggapan kesalahan
SearchAlias	Mewakili alias indeks, yang menjelaskan pemetaan dari nama alias ke indeks. Nama alias dapat digunakan sebagai pengganti nama indeks untuk operasi yang didukung.

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Tanggapan kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

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 dari alias.
indexes	string[]	Nama indeks yang dipetakan alias ini. Hanya satu nama indeks yang dapat ditentukan.
name	string	Nama alias.