Topik ini menjelaskan cara menggunakan Alibaba Cloud CLI untuk memanggil operasi API, termasuk menginstal Alibaba Cloud CLI, mengonfigurasi kredensial, serta membuat dan menjalankan perintah.
Ikhtisar
Untuk memanggil operasi API menggunakan Alibaba Cloud CLI, lakukan langkah-langkah berikut:
Pilih dan instal versi Alibaba Cloud CLI yang sesuai dengan sistem operasi perangkat Anda.
Konfigurasikan kredensial identitas di Alibaba Cloud CLI, termasuk pasangan AccessKey dan ID wilayah. Alibaba Cloud CLI menggunakan informasi kredensial tersebut untuk memanggil operasi API.
Tentukan parameter di OpenAPI Explorer untuk menghasilkan contoh perintah CLI yang berisi parameter yang ditentukan, lalu salin perintah tersebut.
Tempel perintah ke dalam tool shell, sesuaikan opsi perintah sesuai kebutuhan bisnis Anda, lalu jalankan perintah untuk memanggil operasi API yang sesuai.
Prasyarat
Akun Alibaba Cloud telah dibuat. Anda dapat membuat Akun Alibaba Cloud di website resmi Alibaba Cloud. Kami menyarankan agar Anda membuat RAM user untuk memanggil operasi API. Untuk informasi selengkapnya, lihat Buat RAM user.
Layanan Alibaba Cloud yang operasi API-nya ingin Anda panggil telah diaktifkan. Anda dapat menggunakan salah satu metode berikut untuk mengaktifkan layanan Alibaba Cloud yang diperlukan. Dalam contoh ini, Short Message Service (SMS) diaktifkan.
Login ke konsol User Center. Di halaman aktivasi layanan, cari SMS, centang kotak sebelum SMS, lalu klik Activate.
Login ke konsol masing-masing layanan Alibaba Cloud yang ingin Anda aktifkan. Misalnya, Anda dapat login ke konsol SMS dan klik Activate Now di halaman Aktivasi pada konsol SMS.
Alibaba Cloud CLI didukung oleh layanan Alibaba Cloud yang operasi API-nya ingin Anda panggil. Untuk memeriksa apakah suatu layanan Alibaba Cloud mendukung Alibaba Cloud CLI, lakukan salah satu operasi berikut:
Lihat dokumentasi layanan Alibaba Cloud tersebut dan pilih Developer Reference > API integration overview untuk memeriksa apakah layanan tersebut mendukung Alibaba Cloud CLI.
Jalankan perintah
aliyun --helpdi Cloud Shell yang disediakan oleh Alibaba Cloud untuk mengkueri daftar layanan Alibaba Cloud yang mendukung Alibaba Cloud CLI.
Langkah 1: Instal Alibaba Cloud CLI
Anda harus menginstal Alibaba Cloud CLI sebelum menggunakannya. Alibaba Cloud CLI mendukung Windows, Linux, dan macOS. Pilih paket instalasi yang sesuai dengan sistem operasi perangkat Anda. Untuk informasi selengkapnya, lihat topik berikut:
Anda juga dapat menggunakan Cloud Shell Alibaba Cloud untuk men-debug perintah yang ingin Anda jalankan di Alibaba Cloud CLI. Untuk informasi selengkapnya tentang Cloud Shell, lihat Apa itu Cloud Shell?
Langkah 2: Konfigurasi Alibaba Cloud CLI
Untuk memastikan keamanan akun Anda, kami menyarankan agar Anda membuat RAM user dan mendapatkan kredensial identitas RAM user tersebut. Untuk informasi selengkapnya, lihat Solusi keamanan kredensial.
Sebelum menggunakan Alibaba Cloud CLI, Anda harus menentukan informasi seperti kredensial identitas dan ID wilayah. Alibaba Cloud CLI mendukung berbagai jenis kredensial identitas. Untuk informasi selengkapnya, lihat bagian "Jenis kredensial" pada topik Konfigurasi profil. Dalam contoh ini, digunakan kredensial AccessKey. Lakukan langkah-langkah berikut untuk mengonfigurasi Alibaba Cloud CLI:
Buat RAM user dan berikan izin kepada RAM user tersebut untuk mengelola layanan Alibaba Cloud sesuai kebutuhan bisnis Anda. Untuk informasi selengkapnya, lihat Buat RAM user dan Berikan izin kepada RAM user.
Buat pasangan AccessKey untuk RAM user tersebut dan catat
AccessKey IDdanAccessKey secretuntuk konfigurasi kredensial identitas. Untuk informasi selengkapnya, lihat bagian "Buat pasangan AccessKey untuk RAM user" pada topik Buat pasangan AccessKey.Dapatkan dan catat ID wilayah yang tersedia untuk konfigurasi kredensial identitas. Alibaba Cloud CLI menggunakan ID wilayah yang ditentukan untuk memulai panggilan API. Untuk informasi selengkapnya tentang wilayah yang tersedia, lihat Wilayah dan zona.
CatatanSaat menggunakan Alibaba Cloud CLI, Anda dapat menggunakan opsi
--regionuntuk menjalankan perintah di wilayah tertentu. Jika Anda menggunakan opsi ini, Alibaba Cloud CLI akan mengabaikan informasi wilayah dalam konfigurasi kredensial default dan pengaturan variabel lingkungan. Untuk informasi selengkapnya, lihat Opsi baris perintah.Gunakan pasangan AccessKey RAM user tersebut untuk mengonfigurasi kredensial AccessKey dalam file konfigurasi bernama
AkProfile. Untuk informasi selengkapnya, lihat bagian "Contoh konfigurasi" pada topik Konfigurasi profil.
Langkah 3: Hasilkan perintah
OpenAPI Explorer memungkinkan Anda menghasilkan semua perintah Alibaba Cloud CLI secara online. Kami menyarankan agar Anda menggunakan metode ini untuk mendapatkan contoh perintah yang Anda perlukan. Untuk informasi selengkapnya, lihat Hasilkan perintah.
Di kotak pencarian sebelah kiri halaman Debugging, cari operasi API yang ingin Anda panggil. Di tab Parameters operasi API tersebut, tentukan parameter sesuai referensi API. Klik tab CLI Example di sisi kanan tab Parameters untuk melihat contoh perintah yang dihasilkan berisi parameter yang telah ditentukan.
Klik ikon Run Command
untuk membuka Cloud Shell dan men-debug perintah di Cloud Shell.Klik ikon
untuk menyalin contoh perintah ke clipboard. Anda dapat menempel contoh perintah tersebut ke dalam tool shell Anda untuk menjalankannya.Perhatikan format parameter saat menempel contoh perintah ke dalam tool shell Anda. Untuk informasi selengkapnya tentang format parameter Alibaba Cloud CLI, lihat Format parameter.
Secara default, OpenAPI Explorer menambahkan opsi
--regionke perintah CLI yang dihasilkan. Saat Anda menyalin perintah tersebut ke shell lokal Anda, Alibaba Cloud CLI akan mengabaikan informasi wilayah dalam konfigurasi kredensial default dan pengaturan variabel lingkungan, serta menggunakan wilayah yang ditentukan untuk menjalankan perintah. Anda dapat menghapus atau mempertahankan opsi ini sesuai kebutuhan bisnis Anda.
Langkah 4: Panggil operasi API
Sintaksis
Di Alibaba Cloud CLI, Anda dapat menggunakan sintaksis yang ditunjukkan dalam blok kode berikut untuk menjalankan perintah. Untuk informasi selengkapnya, lihat Hasilkan dan jalankan perintah CLI.
aliyun <command> <subcommand> [options and parameters]Opsi perintah
Saat menggunakan Alibaba Cloud CLI, Anda dapat menentukan opsi perintah untuk mengubah perilaku perintah atau mengimplementasikan fitur tambahan. Opsi perintah berikut sering digunakan:
--profile <profileName>: Anda dapat menggunakan opsi--profiledan parameterprofileNameuntuk menentukan profil konfigurasi. Setelah menentukan profil konfigurasi yang valid, Alibaba Cloud CLI akan mengabaikan informasi dalam konfigurasi kredensial default dan pengaturan variabel lingkungan, serta menggunakan konfigurasi yang Anda tentukan untuk menjalankan perintah.--help: Anda dapat menggunakan opsi--helpuntuk mendapatkan informasi bantuan tentang suatu perintah. Untuk informasi selengkapnya, lihat Gunakan perintah help.
Untuk informasi selengkapnya, lihat Opsi baris perintah.
Jalankan perintah
Setelah contoh perintah dihasilkan, salin perintah tersebut dan tempel ke dalam tool shell untuk menjalankannya. Sebagai contoh, jalankan perintah berikut untuk memanggil operasi CreateInstance dari Elastic Compute Service guna membuat instance ECS bayar sesuai penggunaan:
aliyun ecs CreateInstance
--InstanceName myvm1
--ImageId centos_7_03_64_40G_alibase_20170625.vhd
--InstanceType ecs.n4.small
--SecurityGroupId sg-xxxxxx123
--VSwitchId vsw-xxxxxx456
--InternetChargeType PayByTraffic
--Password xxxUntuk informasi selengkapnya tentang cara menjalankan perintah, lihat bagian "Contoh" pada topik Hasilkan dan jalankan perintah CLI atau topik CLI integration example setiap layanan Alibaba Cloud.