Cara mendapatkan kunci API - Alibaba Cloud Model Studio - Alibaba Cloud Documentation Center

Sebelum menggunakan model atau aplikasi di Alibaba Cloud Model Studio, Anda harus mendapatkan kunci API untuk otentikasi.

Catatan

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 lebih lanjut, lihat Token Plan API Key dan Coding Plan API Key.

Buat kunci API

Penting

Prosedur ini harus dilakukan oleh Akun Alibaba Cloud atau RAM user dengan izin administrator atau API-Key pada halaman.

China (Beijing), Singapura, dan wilayah lainnya

Buka Konsol Alibaba Cloud Model Studio. Di pojok kanan atas, pilih wilayah, seperti China (Beijing), Singapore, Jepang (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.
- Permission: 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 kunci API untuk memanggil semua model dan aplikasi.
- Custom: Memungkinkan Anda mengonfigurasi IP address whitelist dan accessible model scope.
  
  Secara default, seluruh 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 akan ditampilkan dalam kotak dialog. Anda harus segera menyalin atau mengunduh dan menyimpannya 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, atur ulang atau buat yang baru.

Akun Alibaba Cloud dapat melihat semua kunci API. RAM user hanya dapat melihat kunci API yang mereka buat sendiri.

Pada halaman manajemen API key, klik + Create API key di pojok kanan atas untuk membuat kunci lain. Untuk kunci API yang sudah ada, Anda dapat Disable, Edit, atau Delete pada kolom Actions.

Wilayah US (Virginia)

Buka Konsol Alibaba Cloud Model Studio. Di pojok kanan atas, ubah wilayah menjadi US (Virginia). Pada tab Dashboard, pilih API Key dari panel navigasi kiri. Pada halaman manajemen kunci API, klik Create API Key.
Pada kotak dialog, konfigurasikan informasi berikut, lalu klik OK:
- Workspace: Kami menyarankan Anda memilih workspace default.
- Description: Masukkan deskripsi untuk membantu Anda mengidentifikasi tujuan kunci API tersebut.
Setelah kunci dibuat, kunci API lengkap akan ditampilkan dalam kotak dialog. Segera salin dan simpan dengan aman. Anda tidak dapat melihat kembali kunci API lengkap setelah menutup kotak dialog.
Pada daftar kunci API, klik ikon di samping kunci API untuk menyalin kunci yang telah dimasking.

Akun Alibaba Cloud dapat melihat semua kunci API. RAM user hanya dapat melihat kunci API yang mereka buat sendiri.

Klik tombol + Create API key di pojok kanan atas untuk membuat kunci API baru.

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 pemanggilan model, buat atau pilih sub-workspace dari daftar.

Untuk informasi lebih lanjut, lihat Izin kunci API dan Menanyakan tagihan dan mengelola biaya.

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 yang tidak disengaja.

Linux

Permanen

Agar kunci API tersedia di semua sesi baru untuk pengguna saat ini, tetapkan sebagai variabel lingkungan permanen.

Jalankan perintah berikut untuk menambahkan pengaturan variabel lingkungan ke file ~/.bashrc.
```
# Ganti YOUR_DASHSCOPE_API_KEY dengan kunci API DashScope Anda
echo "export DASHSCOPE_API_KEY='YOUR_DASHSCOPE_API_KEY'" >> ~/.bashrc
```
Atau, Anda dapat mengedit file ~/.bashrc secara manual.
Modifikasi manual
Jalankan perintah berikut untuk membuka file ~/.bashrc.
```
nano ~/.bashrc
```
Tambahkan konten berikut ke file konfigurasi.
```
# Ganti YOUR_DASHSCOPE_API_KEY dengan kunci API DashScope Anda
export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"
```
Pada editor nano, tekan Ctrl+X, lalu Y, kemudian Enter untuk menyimpan dan menutup file.
Jalankan perintah berikut untuk menerapkan perubahan.
```
source ~/.bashrc
```
Buka jendela terminal baru dan jalankan perintah berikut untuk memverifikasi bahwa variabel lingkungan telah disetel.
```
echo $DASHSCOPE_API_KEY
```

Sementara

Untuk menggunakan variabel lingkungan hanya pada sesi saat ini, tetapkan sebagai variabel lingkungan sementara.

Jalankan perintah berikut.

# Ganti YOUR_DASHSCOPE_API_KEY dengan kunci API DashScope Anda
export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"

Jalankan perintah berikut untuk memverifikasi bahwa variabel lingkungan telah disetel.
```
echo $DASHSCOPE_API_KEY
```

macOS

Permanen

Agar kunci API tersedia di semua sesi baru untuk pengguna saat ini, tetapkan sebagai variabel lingkungan permanen.

Jalankan perintah berikut di terminal Anda untuk memeriksa jenis shell default Anda.
```
echo $SHELL
```
Lanjutkan berdasarkan jenis shell default Anda.
Zsh
1. Jalankan perintah berikut untuk menambahkan pengaturan variabel lingkungan ke file ~/.zshrc.
```
# Ganti YOUR_DASHSCOPE_API_KEY dengan kunci API DashScope Anda
echo "export DASHSCOPE_API_KEY='YOUR_DASHSCOPE_API_KEY'" >> ~/.zshrc
```
  Atau, Anda dapat mengedit file ~/.zshrc secara manual.
  Modifikasi manual
  
  Jalankan perintah berikut untuk membuka file konfigurasi shell.
  nano ~/.zshrc
  
  Tambahkan konten berikut ke file konfigurasi.
  # Ganti YOUR_DASHSCOPE_API_KEY dengan kunci API DashScope Anda export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"
  
  Pada editor nano, tekan Ctrl+X, lalu Y, kemudian Enter untuk menyimpan dan menutup file.
2. Jalankan perintah berikut untuk menerapkan perubahan.
```
source ~/.zshrc
```
3. Buka jendela terminal baru dan jalankan perintah berikut untuk memverifikasi bahwa variabel lingkungan telah disetel.
```
echo $DASHSCOPE_API_KEY
```
Bash
1. Jalankan perintah berikut untuk menambahkan pengaturan variabel lingkungan ke file ~/.bash_profile.
```
# Ganti YOUR_DASHSCOPE_API_KEY dengan kunci API DashScope Anda
echo "export DASHSCOPE_API_KEY='YOUR_DASHSCOPE_API_KEY'" >> ~/.bash_profile
```
  Atau, Anda dapat mengedit file ~/.bash_profile secara manual.
  Modifikasi manual
  
  Jalankan perintah berikut untuk membuka file konfigurasi shell.
  nano ~/.bash_profile
  
  Tambahkan konten berikut ke file konfigurasi.
  # Ganti YOUR_DASHSCOPE_API_KEY dengan kunci API DashScope Anda export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"
  
  Pada editor nano, tekan Ctrl+X, lalu Y, kemudian Enter untuk menyimpan dan menutup file.
2. Jalankan perintah berikut untuk menerapkan perubahan.
```
source ~/.bash_profile
```
3. Buka jendela terminal baru dan jalankan perintah berikut untuk memverifikasi bahwa variabel lingkungan telah disetel.
```
echo $DASHSCOPE_API_KEY
```

Sementara

Untuk menggunakan variabel lingkungan hanya pada sesi saat ini, tetapkan sebagai variabel lingkungan sementara.

Perintah berikut berlaku untuk Zsh dan Bash.

Jalankan perintah berikut.

# Ganti YOUR_DASHSCOPE_API_KEY dengan kunci API DashScope Anda
export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"

Jalankan perintah berikut untuk memverifikasi bahwa variabel lingkungan telah disetel.
```
echo $DASHSCOPE_API_KEY
```

Windows

Di Windows, Anda dapat mengonfigurasi variabel lingkungan menggunakan System Properties, Command Prompt, atau Windows PowerShell.

System Properties

Catatan

Variabel lingkungan yang dikonfigurasi dengan cara ini bersifat permanen.
Anda memerlukan izin administrator untuk mengubah variabel lingkungan sistem.
Perubahan pada variabel lingkungan tidak memengaruhi aplikasi yang sedang berjalan, termasuk jendela Command Prompt dan IDE. Anda harus me-restart aplikasi tersebut atau membuka sesi command-line baru agar perubahan diterapkan.

Di desktop Windows, tekan Win+Q, cari Edit the system environment variables di kotak pencarian, lalu klik hasil pencarian untuk membuka jendela System Properties.
Pada jendela System Properties, klik Environment Variable, lalu pada bagian System variables, klik Create. Untuk Variable Name, masukkan DASHSCOPE_API_KEY, dan untuk Variable value, masukkan kunci API DashScope Anda.
Klik OK pada ketiga jendela yang terbuka untuk menyimpan perubahan dan menutupnya.

Buka jendela Command Prompt atau Windows PowerShell baru dan jalankan perintah yang sesuai untuk memverifikasi bahwa variabel lingkungan telah disetel.

Di Command Prompt:

echo %DASHSCOPE_API_KEY%

Microsoft Windows [Version 10.0.19045.5371]
(c) Microsoft Corporation. All rights reserved.
C:\Windows\system32>echo %DASHSCOPE_API_KEY%
sk-ee16697?fe4
C:\Windows\system32>

Di Windows PowerShell:

echo $env:DASHSCOPE_API_KEY

Windows PowerShell
Copyright (C) Microsoft Corporation. All rights reserved.
Try the new cross-platform PowerShell https://aka.ms/pscore6
PS C:\Windows\system32> echo $env:DASHSCOPE_API_KEY
sk-ee166797fe40xxx
PS C:\Windows\system32>

Command Prompt

Permanen

Agar variabel lingkungan kunci API tersedia di semua sesi baru untuk pengguna saat ini, ikuti langkah-langkah berikut.

Jalankan perintah berikut di Command Prompt.

REM Ganti YOUR_DASHSCOPE_API_KEY dengan kunci API DashScope Anda
setx DASHSCOPE_API_KEY "YOUR_DASHSCOPE_API_KEY"

Buka jendela Command Prompt baru agar perubahan diterapkan.
Di jendela Command Prompt baru, jalankan perintah berikut untuk memverifikasi bahwa variabel lingkungan telah disetel.
```
echo %DASHSCOPE_API_KEY%
```

Sementara

Untuk menggunakan variabel lingkungan hanya pada sesi saat ini, jalankan perintah berikut di Command Prompt.

REM Ganti YOUR_DASHSCOPE_API_KEY dengan kunci API DashScope Anda
set DASHSCOPE_API_KEY=YOUR_DASHSCOPE_API_KEY

Anda dapat menjalankan perintah berikut pada sesi yang sama untuk memverifikasi bahwa variabel lingkungan telah disetel.

echo %DASHSCOPE_API_KEY%

Windows PowerShell

Permanen

Agar variabel lingkungan kunci API tersedia di semua sesi baru untuk pengguna saat ini, ikuti langkah-langkah berikut.

Jalankan perintah berikut di Windows PowerShell.

# Ganti YOUR_DASHSCOPE_API_KEY dengan kunci API DashScope Anda
[Environment]::SetEnvironmentVariable("DASHSCOPE_API_KEY", "YOUR_DASHSCOPE_API_KEY", [EnvironmentVariableTarget]::User)

Buka jendela Windows PowerShell baru agar perubahan diterapkan.
Di jendela Windows PowerShell baru, jalankan perintah berikut untuk memverifikasi bahwa variabel lingkungan telah disetel.
```
echo $env:DASHSCOPE_API_KEY
```

Sementara

Jika Anda ingin menggunakan variabel lingkungan hanya pada sesi saat ini, Anda dapat menjalankan perintah berikut di PowerShell.

# Ganti YOUR_DASHSCOPE_API_KEY dengan kunci API DashScope Anda
$env:DASHSCOPE_API_KEY = "YOUR_DASHSCOPE_API_KEY"

Anda dapat menjalankan perintah berikut pada sesi yang sama untuk memverifikasi bahwa variabel lingkungan telah disetel.

echo $env:DASHSCOPE_API_KEY

Gunakan Kunci API

Metode 1: Panggil model dari alat pihak ketiga

Panduan konfigurasi untuk alat 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.

Jangan memublikasikan kunci API Anda.

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 setelah peningkatan.

Item perbandingan	Kunci sebelum peningkatan	Kunci setelah peningkatan
Format kunci	Diawali dengan `sk-` dan panjangnya sekitar 32 karakter.	Diawali dengan `sk-ws` dan lebih panjang daripada format sebelumnya.
Penayangan 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.

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 model 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.

Catatan

Saat Anda Create API Key atau mengklik Edit untuk Kunci API yang sudah ada, Anda dapat mengubah Permissions menjadi Custom untuk mengonfigurasi hal berikut:

Konfigurasi berikut tidak didukung di Wilayah AS (Virginia).

Daftar putih alamat IP: Hanya mengizinkan alamat IP dalam daftar putih untuk menggunakan Kunci API guna melakukan panggilan (mendukung IPv4, IPv6, dan Blok CIDR).
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 panggilan 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 panggilan model.

T: Saya menggunakan perintah echo dan 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 memengaruhi 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 variabel lingkungan baru dimuat.
- Jika Anda mengatur variabel lingkungan setelah menerapkan 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 file konfigurasi service manager tersebut.
Skenario 4: Menggunakan perintah sudo. Jika Anda menjalankan skrip dengan perintah sudo python xx.py, variabel lingkungan milik pengguna saat ini mungkin tidak diwariskan. Hal ini terjadi karena sudo secara default tidak mewariskan semua variabel lingkungan. Anda dapat menggunakan perintah sudo -E python xx.py, di mana parameter -E memastikan variabel lingkungan dilewatkan. Jika Anda memiliki izin untuk menjalankan skrip tersebut, Anda dapat langsung menjalankan python xx.py.