Saat memanggil layanan OpenSearch LLM-Based Conversational Search Edition melalui API atau SDK, identitas pemanggil harus diautentikasi dan diotorisasi. Topik ini menjelaskan metode autentikasi dan otorisasi serta cara mengelola kunci API.
Autentikasi panggilan API
Autentikasi panggilan API menggunakan kunci API: metode autentikasi yang disediakan oleh OpenSearch LLM-Based Conversational Search Edition. Saat menggunakan metode ini, Anda harus menyediakan kredensial akses berupa kunci API. Anda dapat membuat dan mengaktifkan hingga 10 kunci API per instans.
Untuk mencegah kebocoran kunci API:
-
Jangan mengekspos kunci API Anda dalam bentuk apa pun guna menghindari risiko keamanan atau kerugian finansial akibat penggunaan tidak sah.
-
Panggilan API hanya boleh dilakukan dari sisi server. Setiap panggilan API yang dilakukan dari sisi klien—seperti browser, aplikasi, atau mini program—berpotensi menyebabkan kebocoran kunci API.
-
Jika Anda mencurigai bahwa kunci API telah bocor, segera login ke OpenSearch LLM-Based Conversational Search Edition untuk menonaktifkan lalu menghapus kunci API tersebut. Setelah dinonaktifkan, kunci API tidak dapat lagi digunakan untuk melakukan panggilan API.
Otorisasi panggilan API
Otorisasi panggilan API menggunakan pasangan AccessKey (AK): kredensial akses permanen yang disediakan oleh Alibaba Cloud, terdiri dari ID AccessKey dan Rahasia AccessKey.
Pasangan AccessKey tidak digunakan untuk login ke Konsol. Kredensial ini digunakan untuk mengakses Alibaba Cloud melalui alat pengembangan seperti API, CLI, SDK, dan Terraform. Permintaan membawa signature yang dihasilkan dengan mengenkripsi konten permintaan menggunakan ID AccessKey dan Rahasia AccessKey untuk memverifikasi identitas Anda dan validitas permintaan tersebut.
Kami sangat menyarankan agar Anda membuat RAM user khusus untuk akses API, menghasilkan pasangan AccessKey yang sesuai, memberikan izin berdasarkan prinsip hak istimewa minimal, lalu memanggil layanan development workbench melalui API. Untuk informasi selengkapnya, lihat Buat RAM user dan berikan izin.
Prosedur
-
Login ke Konsol OpenSearch.
-
Pilih wilayah target dan beralih ke OpenSearch LLM-Based Conversational Search Edition.
-
Pada daftar instans, klik Manage di sebelah kanan instans target, lalu pilih API keys di panel navigasi sebelah kiri.
-
Klik Create an API KEY. Sistem akan menghasilkan kunci API. Klik Copy untuk menyimpan kunci API, atau unduh file CSV untuk menyimpan informasi kunci API tersebut.
-
Setelah menyimpan kunci API secara aman, klik I have saved my API KEY., lalu klik OK untuk menutup dialog.
-
Edit: Tambahkan deskripsi untuk kunci API.
-
View: Lihat kunci API.
-
Disable/Enable: Saat dinonaktifkan, kunci API tidak dapat digunakan untuk melakukan panggilan API. Saat diaktifkan, kunci API dapat digunakan untuk melakukan panggilan API.
-
Delete: Anda dapat menghapus kunci API saat statusnya dinonaktifkan.
-
Contoh autentikasi kunci API
Anda juga dapat menyelesaikan autentikasi panggilan menggunakan kunci API. Berikut adalah contoh permintaan curl yang menggunakan autentikasi kunci API untuk mengambil daftar istilah. Setelah mengonfigurasi URL dan kunci API, Anda dapat menjalankan pengujian.
curl --location 'http://***.opensearch-cn-shanghai.aliyuncs.com/v3/openapi/apps/[app_group_identity]/knowledge/entries' \
--header 'Authorization: Bearer Your API Key' \
--header 'Content-Type: application/json' \
Contoh respons:
{
"request_id":"4F6F9BDC-740F-4FC1-B976-74CAFCBF1333",
"status":"OK",
"total_count":2,
"latency":0.0,
"result":[
{
"entry_id":"ca0c8c1cec7c41a280c76c16f0db79f6",
"create_time":1718188424000,
"update_time":1718188424000,
"questions":[
"Di mana alamat kantor untuk menarik dana tabungan perumahan guna membeli rumah tinggal di Hangzhou"
],
"answer":"\"Halo, alamat kantornya adalah ****, telepon kontak: 0571-12329-1\""
},
{
"entry_id":"2f4c7350a7104f029f316706b61b6eb2",
"create_time":1718193627000,
"update_time":1718193627000,
"questions":[
"Apakah seseorang dapat membantu mengurus permohonan pencabutan pendaftaran cabang yang didanai domestik atas nama saya?"
],
"answer":"Ya, hal tersebut dapat diuruskan atas nama Anda. Saat menyerahkan dokumen di loket di tempat, surat otorisasi ***** dan orang yang diberi kuasa harus menandatangani secara langsung."
}
],
"errors":[]
}