Kelola kunci API - OpenSearch

Untuk mengakses OpenSearch LLM-Based Conversational Search Edition menggunakan API atau SDK, Anda memerlukan otorisasi. Topik ini menjelaskan metode otorisasi dan otentikasi oleh OpenSearch LLM-Based Conversational Search Edition, serta cara mengelola kunci API.

Otorisasi panggilan API

OpenSearch LLM-Based Conversational Search Edition menggunakan kunci API untuk mengotorisasi panggilan API. Maksimal 10 kunci API dapat dibuat dan diaktifkan untuk setiap instans.

Penting

Untuk melindungi kunci API, harap:

Jangan mengekspos kunci API dengan cara apa pun. Ini mencegah risiko keamanan atau kerugian finansial akibat penggunaan tanpa izin.

Pastikan bahwa semua panggilan API hanya dilakukan dari server. Panggilan API yang dimulai dari klien, seperti browser, aplikasi, atau mini program, dapat menyebabkan pengungkapan kunci API.
Jika pengungkapan kunci API mencurigakan terdeteksi, masuk ke Konsol OpenSearch untuk menonaktifkan lalu menghapus kunci API yang terungkap. Setelah kunci API dinonaktifkan, Anda tidak dapat memanggil OpenSearch LLM-Based Conversational Search Edition API menggunakan kunci API tersebut.

Autentikasi panggilan API

OpenSearch LLM-Based Conversational Search Edition menggunakan Pasangan Kunci Akses untuk mengotentikasi panggilan API. Pasangan Kunci Akses adalah kredensial permanen yang disediakan oleh Alibaba Cloud dan terdiri dari ID AccessKey dan Rahasia AccessKey.

Pasangan AccessKey tidak digunakan untuk masuk ke Konsol Manajemen Alibaba Cloud. Mereka digunakan untuk mengakses layanan Alibaba Cloud melalui alat pengembangan seperti API, CLI, SDK, dan Terraform. Untuk setiap permintaan, tanda tangan dihasilkan berdasarkan konten permintaan yang dienkripsi menggunakan ID AccessKey dan Rahasia AccessKey. Tanda tangan ini digunakan untuk memverifikasi identitas pemanggil dan validitas permintaan.

Kami merekomendasikan agar Anda membuat Pengguna Resource Access Management (RAM) untuk memanggil Operasi API, membuat Pasangan Kunci Akses untuk Pengguna RAM, dan kemudian memberikan izin kepada Pengguna RAM berdasarkan prinsip Hak istimewa minimal. Kemudian, Pengguna RAM dapat memanggil Operasi API untuk melakukan pengembangan layanan. Untuk informasi lebih lanjut, lihat Buat Pengguna RAM dan Berikan Izin.

Prosedur

Masuk ke konsol OpenSearch.
Di bilah navigasi atas, pilih wilayah tempat instance Anda berada. Di pojok kiri atas, pilih OpenSearch LLM-Based Conversational Search Edition.
Di halaman Manajemen Instance, temukan instance yang ingin Anda kelola dan klik Manage di kolom Tindakan. Di panel sebelah kiri, klik API keys.
Klik Create API Key. Sistem akan menghasilkan kunci API. Klik Salin untuk menyimpan kunci API atau Unduh File CSV untuk mengunduh kunci API sebagai file CSV.
Setelah menyimpan Kunci API, pilih I have saved my API KEY dan klik OK.
- Edit: Tambahkan deskripsi untuk kunci API.
- Lihat: Lihat kunci API.
- Nonaktifkan atau Aktifkan: Nonaktifkan atau aktifkan kunci API. Kunci API yang dinonaktifkan tidak dapat digunakan untuk memanggil OpenSearch LLM-Based Conversational Search Edition API.
- Hapus: Hapus kunci API yang dinonaktifkan.

Contoh otorisasi berbasis kunci API

Gunakan kunci API untuk mengotorisasi panggilan API. Contoh berikut menunjukkan cara menggunakan kunci API untuk mengotorisasi permintaan curl. Mulai permintaan setelah Anda menentukan URL dan kunci API.

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' \

Tanggapan contoh:

{
  "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 perumahan untuk membeli rumah hunian di Hangzhou?"
      ],
      "answer":"\"Alamat kantor adalah ****. Nomor telepon kantor adalah 0571-12329-1.\""
      },
    {
      "entry_id":"2f4c7350a7104f029f316706b61b6eb2",
      "create_time":1718193627000,
      "update_time":1718193627000,
      "questions":[
          "Apakah seorang agen dapat mengajukan pembatalan cabang domestik atas nama orang lain?"
      ],
      "answer":"Ya, seorang agen dapat mengajukan pembatalan cabang domestik atas nama orang lain. Agen harus menyerahkan materi otorisasi di jendela di tempat. ***** Materi tersebut harus ditandatangani oleh pemberi kuasa secara langsung."
    }
    ],
    "errors":[]
}