Sebelum menggunakan model atau aplikasi di Alibaba Cloud Model Studio, Anda harus mendapatkan kunci API untuk autentikasi.
Topik ini menjelaskan kunci API pay-as-you-go untuk Model Studio. Jika Anda menggunakan Token Plan atau Coding Plan, gunakan kunci API khusus yang sesuai (diawali dengan
sk-sp-). Untuk informasi selengkapnya, lihat Token Plan API Key dan Coding Plan API Key.Buat kunci API
- China (Beijing), Singapura, dan wilayah lainnya
- Wilayah AS (Virginia)
- Buka Konsol Alibaba Cloud Model Studio. Di sudut kanan atas, pilih wilayah, seperti China (Beijing), Singapore, Japan (Tokyo), China (Hong Kong), atau Germany (Frankfurt). Buka halaman API Key, lalu klik Create API Key.
-
Pada kotak dialog, konfigurasikan pengaturan berikut, lalu klik OK.
- Workspace: Kami menyarankan Anda memilih workspace default.
- Description (opsional, maksimal 200 karakter): Masukkan deskripsi untuk membantu mengidentifikasi tujuan kunci API tersebut.
- Permissions: Kami menyarankan Anda memilih All. Untuk kontrol yang lebih granular, pilih Custom untuk mengonfigurasi alamat IP dan model yang dapat diakses.
Bagaimana cara memilih pengaturan izin untuk kunci API?
Alibaba Cloud Model Studio menyediakan dua jenis pengaturan izin. Pilih salah satu berdasarkan kebutuhan bisnis Anda:- All: Memberikan izin kepada kunci API untuk memanggil model atau aplikasi apa pun.
-
Custom: Memungkinkan Anda mengonfigurasi daftar putih alamat IP dan cakupan model yang dapat diakses.
Secara default, semua trafik IPv4 (
0.0.0.0/0) diizinkan. Dukungan IPv6 hanya tersedia di wilayah China (Beijing).Anda dapat menambahkan hingga 20 alamat IPv4 atau IPv6, atau Blok CIDR ke daftar putih alamat IP.
-
Setelah kunci dibuat, kunci API lengkap dan API Host (alamat titik akhir layanan) akan ditampilkan dalam kotak dialog. Segera salin atau unduh dan simpan secara rahasia. Siapa pun yang memiliki kunci API Anda dapat membuat permintaan layanan atas nama Anda, yang dapat menimbulkan biaya. Setelah menutup kotak dialog, Anda tidak dapat melihat atau menyalin kunci API dalam bentuk teks biasa lagi. Jika kunci hilang, setel ulang atau buat yang baru.
Akun Alibaba Cloud dapat melihat kunci API di semua workspace. RAM user hanya dapat melihat kunci API di workspace yang telah mereka ikuti.
di samping kunci API untuk menyalin kunci yang disembunyikan sebagian.Operasi manajemen kunci API
Operasi manajemen kunci API
Pada daftar kunci API, Anda dapat melakukan operasi berikut pada kunci API yang sudah ada:
- Edit: Ubah deskripsi dan pengaturan izin kunci API.
- Delete: Hapus permanen kunci API. Operasi ini tidak dapat dibatalkan.
- Disable (tidak didukung di wilayah AS (Virginia)): Menangguhkan kunci API tanpa menghapusnya. Anda dapat mengaktifkannya kembali kapan saja.
- Reset (tidak didukung di wilayah AS (Virginia)): Hasilkan nilai kunci baru. Kunci lama langsung menjadi tidak valid.
Kapan menggunakan akun pemilik atau workspace lain
Kapan menggunakan akun pemilik atau workspace lain
Jika Anda memerlukan kolaborasi tim atau alokasi biaya, pertimbangkan hal berikut:
- Workspace: Workspace digunakan untuk mengisolasi sumber daya dan izin untuk proyek atau tim yang berbeda. Untuk mengontrol model mana yang dapat dipanggil oleh kelompok pengguna atau mengalokasikan biaya panggilan model, buat atau pilih sub-workspace dari daftar.
Konfigurasikan kunci API sebagai variabel lingkungan
Kami menyarankan menyetel kunci API Anda sebagai variabel lingkungan. Hal ini membantu Anda menghindari hard-coding kunci dalam kode sumber, sehingga mengurangi risiko paparan tidak sengaja.
- Linux
- macOS
- Windows
- Permanen
- Sementara
Agar kunci API tersedia di semua sesi baru untuk pengguna saat ini, tetapkan sebagai variabel lingkungan permanen.Atau, Anda dapat mengedit file
- Jalankan perintah berikut untuk menambahkan pengaturan variabel lingkungan ke file
~/.bashrc.
~/.bashrc secara manual.Modifikasi manual
Modifikasi manual
Jalankan perintah berikut untuk membuka file Tambahkan konten berikut ke file konfigurasi.Pada editor nano, tekan Ctrl+X, lalu Y, kemudian Enter untuk menyimpan dan menutup file.
~/.bashrc.- Jalankan perintah berikut untuk menerapkan perubahan.
- Buka jendela terminal baru dan jalankan perintah berikut untuk memverifikasi bahwa variabel lingkungan telah disetel.
Gunakan kunci API
- Metode 1: Panggil model darithird-party tools Panduan konfigurasi untuk tool umum: Chatbox, Cline, Claude Code, Dify, OpenClaw, Postman, dan Qwen Code.
- Metode 2: Panggil model menggunakan kode Saat Anda memanggil API Qwen untuk pertama kalinya menggunakan kode, kami menyarankan agar Anda mengonfigurasi kunci API sebagai variabel lingkungan untuk menghindari hard-coding di dalam kode Anda, sehingga mengurangi risiko kebocoran.
Saat Anda memanggil model dari kode atau third-party tool, selain kunci API, Anda juga harus menentukan service endpoint (yaitu API Host yang ditampilkan pada dialog keberhasilan pembuatan, yang sesuai dengan
base_url dalam SDK atau permintaan HTTP Anda). Model Studio menyediakan antarmuka protokol OpenAI-compatible dan Anthropic-compatible. Nilai base_url berbeda antara kedua protokol tersebut dan bervariasi berdasarkan wilayah. Lihat dokumentasi untuk protokol yang Anda gunakan:- Protokol OpenAI-compatible: OpenAI compatible - Chat
- Protokol Anthropic-compatible: Anthropic-compatible Messages
Peningkatan keamanan kunci API
Model Studio telah meningkatkan mekanisme pembuatan dan penyimpanan kunci API pay-as-you-go untuk keamanan yang lebih baik (kecuali untuk wilayah AS (Virginia)). Kunci API yang dibuat sebelum peningkatan dan diawali dengan sk- tetap berfungsi penuh dan tidak terpengaruh. Semua kunci API yang dibuat setelah peningkatan diawali dengan sk-ws.
Tabel berikut menjelaskan perbedaan utama antara kunci API yang dibuat sebelum dan sesudah peningkatan.
Item perbandingan | Kunci sebelum peningkatan | Kunci setelah peningkatan |
|---|---|---|
Format kunci | Diawali dengan | Diawali dengan |
Tampilan teks biasa | Anda dapat menyalin kunci teks biasa lengkap dari Konsol kapan saja. | Kunci teks biasa hanya ditampilkan sekali saat pembuatan. Kunci tersebut tidak dapat dilihat lagi setelah kotak dialog ditutup. Jika hilang, lakukan reset atau buat kunci baru. |
Kemampuan pemanggilan | Dapat digunakan untuk memanggil model secara normal; fungsionalitas tidak terpengaruh. | Dapat digunakan untuk memanggil model secara normal; fungsionalitasnya identik dengan kunci sebelum peningkatan. |
Aksi yang disarankan | Kami menyarankan Anda membuat kunci baru untuk menggantikan kunci lama demi keamanan yang lebih baik. | Salin dan simpan kunci segera setelah pembuatan, serta simpan dengan aman. |
Manage API keys through the API
Selain operasi melalui Konsol, Alibaba Cloud Model Studio menyediakan operasi OpenAPI yang memungkinkan Anda membuat, mengkueri, mengedit, menghapus, mengaktifkan, menonaktifkan, dan mereset API key secara terprogram, sehingga Anda dapat mengintegrasikan manajemen API key ke dalam alur kerja otomatis.
Pemanggilan operasi berikut memerlukan autentikasi signature menggunakan AccessKey Akun Alibaba Cloud Anda (bukan API key itu sendiri) dan izin RAM yang sesuai. Anda dapat melakukan debug setiap operasi secara online di portal developer OpenAPI, atau memanggilnya melalui SDK Alibaba Cloud.
Operation | Description |
|---|---|
Membuat API key. | |
Mengkueri informasi API key tertentu. | |
Mengkueri daftar API key. | |
Mengedit API key, seperti deskripsi dan konfigurasi izinnya. | |
Menghapus API key. Operasi ini tidak dapat dikembalikan. | |
Mengaktifkan API key (tidak didukung di wilayah US (Virginia)). | |
Menonaktifkan API key. Kunci tersebut tetap disimpan dan dapat diaktifkan kembali kapan saja (tidak didukung di wilayah US (Virginia)). | |
Mereset API key. Nilai kunci baru akan dihasilkan dan kunci lama langsung menjadi tidak valid (tidak didukung di wilayah US (Virginia)). |
izin Kunci API
Izin suatu Kunci API ditentukan sepenuhnya oleh ruang kerjanya. Semua Kunci API dalam ruang kerja yang sama memiliki izin yang identik. Anda tidak perlu membuat Kunci API berbeda untuk model yang berbeda, seperti model teks-ke-teks, teks-ke-gambar, atau sintesis suara.
- Kunci API di ruang kerja default: Dapat memanggil semua model standar dan setiap aplikasi dalam ruang kerja default.
- Kunci API di sub-ruang kerja: Dapat memanggil model standar yang diotorisasi untuk sub-ruang kerja tersebut dan setiap aplikasi dalam sub-ruang kerja itu.
Saat Anda Create API Key atau mengklik Edit untuk Kunci API yang sudah ada, Anda dapat mengubah Permissions menjadi Custom dan mengonfigurasi hal berikut:
- Daftar putih alamat IP: Hanya mengizinkan alamat IP dalam daftar putih untuk menggunakan Kunci API guna melakukan panggilan (mendukung Alamat IPv4 dan Blok CIDR; IPv6 hanya didukung di wilayah China (Beijing), sedangkan wilayah AS (Virginia) hanya mendukung IPv4).
- Access Scope: Pilih model atau aplikasi spesifik yang dapat diakses oleh Kunci API ini. Kunci tersebut tidak dapat memanggil sumber daya yang tidak dipilih.
Validitas Kunci API
Kunci API tidak kedaluwarsa. Kunci tersebut tetap valid hingga Anda menghapusnya secara manual.
Untuk memberikan akses temporary kepada aplikasi atau pengguna pihak ketiga, atau untuk mengontrol secara ketat operasi berisiko tinggi seperti mengakses atau menghapus data sensitif, Anda dapat membuat Kunci API temporary (berlaku selama 60 detik). Hal ini menghindari paparan Kunci API jangka panjang dan mengurangi risiko kebocoran.
Kode error
Jika pemanggilan model gagal dan mengembalikan pesan error, lihat Kode error untuk troubleshooting.
FAQ
T: Berapa banyak kunci API yang dapat saya buat dalam satu akun Alibaba Cloud?
J: Untuk wilayah Singapura, China (Beijing), China (Hong Kong), Jepang (Tokyo), dan Jerman (Frankfurt), setiap akun Alibaba Cloud dapat membuat hingga 50 kunci API per wilayah.
Untuk wilayah AS (Virginia), setiap akun pemilik, termasuk akun Alibaba Cloud, dapat membuat hingga 20 kunci API.
T: Apakah kunci API yang dibuat oleh RAM user tetap valid setelah pengguna tersebut dihapus?
J: Tidak. Setelah Anda menonaktifkan atau menghapus RAM user di Konsol RAM, semua kunci API yang dibuat oleh pengguna tersebut menjadi tidak valid dan tidak dapat lagi digunakan untuk pemanggilan model.
T: Saya menggunakan perintahechodan telah memastikan variabel lingkungan diatur dengan benar. Mengapa kode saya tetap melaporkan bahwa kunci API tidak ditemukan?
J: Hal ini dapat terjadi karena alasan berikut:
- Skenario 1: Variabel lingkungan temporary telah diatur. Variabel temporary hanya berlaku dalam sesi terminal saat ini dan tidak berpengaruh pada IDE atau aplikasi lain yang sedang berjalan. Ikuti petunjuk dalam topik ini untuk mengatur variabel lingkungan permanen.
-
Skenario 2: IDE, tool command-line, atau aplikasi belum direstart.
- Anda harus merestart IDE (seperti VS Code) atau terminal agar memuat variabel lingkungan baru.
- Jika Anda mengatur variabel lingkungan setelah men-deploy aplikasi, Anda harus merestart layanan aplikasi tersebut agar variabel lingkungan dimuat ulang.
- Skenario 3: Variabel tidak ada dalam file konfigurasi layanan. Jika aplikasi Anda dijalankan oleh service manager, seperti systemd atau supervisord, Anda mungkin perlu menambahkan variabel lingkungan ke dalam file konfigurasi service manager tersebut.
-
Skenario 4: Menggunakan perintah
sudo. Jika Anda menjalankan skrip dengan perintahsudo python xx.py, variabel lingkungan dari pengguna saat ini mungkin tidak diwariskan. Hal ini karenasudosecara default tidak mewariskan semua variabel lingkungan. Anda dapat menggunakan perintahsudo -E python xx.py, di mana parameter-Ememastikan variabel lingkungan diteruskan. Jika Anda memiliki izin untuk menjalankan skrip tersebut, Anda dapat langsung menjalankanpython xx.py.