Aliases - Get

Layanan:
Search Service
Versi API:
2026-08-01-preview

Mengambil definisi alias.

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
aliasName
 path True

string

Nama alias.
endpoint
 path True

string (uri)

URL titik akhir layanan pencarian.
api-version
 query True

string

minLength: 1

Versi API yang akan digunakan untuk operasi ini.

Header Permintaan

Nama Diperlukan Jenis Deskripsi
Accept

Accept

Header Terima.
x-ms-client-request-id

string (uuid)

Pengidentifikasi string yang buram dan unik secara global yang dihasilkan klien untuk permintaan tersebut.

Respons

Nama Jenis Deskripsi
200 OK

SearchAlias

Permintaan telah berhasil.
Other Status Codes

ErrorResponse

Respons kesalahan yang tidak terduga.

Keamanan

api-key

Jenis: apiKey
Dalam: header

OAuth2Auth

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Cakupan

Nama Deskripsi
https://search.azure.com/.default

Contoh

SearchServiceGetAlias

Permintaan sampel

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

Respon sampel

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

Definisi

Nama Deskripsi
Accept

Header Terima.
ErrorAdditionalInfo

Informasi tambahan tentang kesalahan pengelolaan sumber daya.
ErrorDetail

Detail kesalahan.
ErrorResponse

Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. (Ini juga mengikuti format respons kesalahan OData.).
SearchAlias

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

Accept

Enumerasi

Header Terima.

Nilai Deskripsi
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Objek

Informasi tambahan tentang kesalahan pengelolaan sumber daya.

Nama Jenis Deskripsi
info

Info tambahan.
type

string

Jenis informasi tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama Jenis Deskripsi
additionalInfo

ErrorAdditionalInfo[]

Informasi tambahan tentang kesalahan.
code

string

Kode kesalahan.
details

ErrorDetail[]

Rincian kesalahan.
message

string

Pesan kesalahan.
target

string

Sasaran kesalahan.

ErrorResponse

Objek

Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. (Ini juga mengikuti format respons kesalahan OData.).

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.