Aliases - Create Or Update

Layanan:: Search Service

Versi API:: 2023-10-01-Preview

Membuat alias pencarian baru atau memperbarui alias jika sudah ada.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
aliasName	path	True	string	Definisi alias untuk membuat atau memperbarui.
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.
If-Match		string	Menentukan kondisi If-Match. Operasi akan dilakukan hanya jika ETag pada server cocok dengan nilai ini.
If-None-Match		string	Menentukan kondisi If-None-Match. Operasi akan dilakukan hanya jika ETag pada server tidak cocok dengan nilai ini.
Prefer	True	string	Untuk permintaan HTTP PUT, menginstruksikan layanan untuk mengembalikan sumber daya yang dibuat/diperbarui saat berhasil.

Isi Permintaan

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

Respons

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

Contoh

SearchServiceCreateOrUpdateAlias

Permintaan sampel

HTTP

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


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

Respon sampel

Kode status:: 200

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

Kode status:: 201

{
  "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.