Mulai menggunakan Alibaba Cloud CLI - Alibaba Cloud CLI

Topik ini menjelaskan cara menggunakan Alibaba Cloud CLI untuk memanggil operasi API, termasuk menginstal Alibaba Cloud CLI, mengonfigurasi kredensial, serta menghasilkan dan menjalankan perintah.

Ikhtisar

Untuk memanggil operasi API menggunakan Alibaba Cloud CLI, ikuti langkah-langkah berikut:

Pilih dan instal versi Alibaba Cloud CLI sesuai dengan sistem operasi perangkat Anda.
Konfigurasikan informasi kredensial di Alibaba Cloud CLI, seperti pasangan AccessKey dan ID wilayah. Alibaba Cloud CLI menggunakan informasi ini untuk memanggil operasi API.
Tentukan parameter di OpenAPI Explorer untuk menghasilkan contoh perintah CLI yang berisi parameter tersebut. Salin perintah yang dihasilkan.
Tempelkan perintah ke dalam alat shell, tentukan opsi perintah sesuai kebutuhan bisnis Anda, lalu jalankan perintah untuk memanggil operasi API yang relevan.

Prasyarat

Akun Alibaba Cloud telah dibuat. Anda dapat membuat akun di Situs Resmi Alibaba Cloud. Kami menyarankan Anda membuat pengguna RAM untuk memanggil operasi API. Untuk detail lebih lanjut, lihat Buat Pengguna RAM.
Layanan Alibaba Cloud yang ingin Anda panggil operasi API-nya telah diaktifkan. Anda dapat menggunakan salah satu metode berikut untuk mengaktifkan layanan yang diperlukan. Sebagai contoh, aktifkan Short Message Service (SMS).
- Masuk ke konsol Pusat Pengguna. Di halaman aktivasi layanan, cari SMS, pilih kotak centang sebelum SMS, lalu klik Activate.
- Masuk ke konsol layanan Alibaba Cloud yang ingin Anda aktifkan. Sebagai contoh, masuk ke konsol SMS dan klik Activate Now di halaman Aktivasi SMS.
Alibaba Cloud CLI didukung oleh layanan Alibaba Cloud yang ingin Anda panggil operasi API-nya. Untuk memeriksa apakah layanan mendukung Alibaba Cloud CLI, gunakan salah satu metode berikut:
- Lihat dokumentasi layanan Alibaba Cloud dan pilih Developer Reference > API integration overview untuk memverifikasi dukungan terhadap Alibaba Cloud CLI.
- Jalankan perintah aliyun --help di Cloud Shell untuk melihat daftar layanan yang mendukung Alibaba Cloud CLI.

Langkah 1: Instal Alibaba Cloud CLI

Instal Alibaba Cloud CLI sebelum menggunakannya. CLI mendukung Windows, Linux, dan macOS. Pilih paket instalasi sesuai dengan sistem operasi perangkat Anda. Untuk detail lebih lanjut, lihat topik-topik berikut:

Anda juga dapat menggunakan Cloud Shell dari Alibaba Cloud untuk men-debug perintah yang ingin dijalankan di CLI. Untuk informasi lebih lanjut tentang Cloud Shell, lihat Apa itu Cloud Shell?

Langkah 2: Konfigurasikan Alibaba Cloud CLI

Penting

Untuk memastikan keamanan akun Anda, kami menyarankan Anda membuat pengguna RAM dan mendapatkan kredensial identitas pengguna RAM. Untuk detail lebih lanjut, lihat Solusi Keamanan Kredensial.

Sebelum menggunakan Alibaba Cloud CLI, tentukan informasi seperti kredensial identitas dan ID wilayah. CLI mendukung berbagai jenis kredensial identitas. Untuk detail lebih lanjut, lihat bagian "Jenis Kredensial" dari topik Konfigurasikan Profil. Dalam contoh ini, digunakan kredensial AccessKey. Ikuti langkah-langkah berikut untuk mengonfigurasi CLI:

Buat pengguna RAM dan berikan izin kepada pengguna RAM untuk mengelola layanan Alibaba Cloud sesuai kebutuhan bisnis Anda. Untuk detail lebih lanjut, lihat Buat Pengguna RAM dan Berikan Izin kepada Pengguna RAM.
Buat pasangan AccessKey untuk pengguna RAM dan catat ID AccessKey dan Rahasia AccessKey untuk konfigurasi kredensial identitas. Untuk detail lebih lanjut, lihat bagian "Buat Pasangan AccessKey untuk Pengguna RAM" dari 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 pemanggilan API. Untuk informasi lebih lanjut tentang wilayah yang tersedia, lihat Wilayah dan Zona.
Catatan
Saat menggunakan Alibaba Cloud CLI, Anda dapat menggunakan opsi --region untuk menjalankan perintah di wilayah tertentu. Jika Anda menggunakan opsi ini, CLI akan mengabaikan informasi wilayah dalam konfigurasi kredensial default dan pengaturan variabel lingkungan. Untuk detail lebih lanjut, lihat Opsi Baris Perintah.
Gunakan pasangan AccessKey pengguna RAM untuk mengonfigurasi kredensial AccessKey di file konfigurasi bernama AkProfile. Untuk detail lebih lanjut, lihat bagian "Contoh Konfigurasi" dari topik Konfigurasikan Profil.

Langkah 3: Hasilkan Perintah

Catatan

OpenAPI Explorer memungkinkan Anda menghasilkan semua perintah Alibaba Cloud CLI secara online. Kami menyarankan Anda menggunakan metode ini untuk mendapatkan perintah contoh yang Anda butuhkan. Untuk detail lebih lanjut, lihat Hasilkan Perintah.

Di kotak pencarian di sisi kiri halaman Debugging, cari operasi API yang ingin Anda panggil. Pada tab Parameters operasi API, tentukan parameter berdasarkan referensi API. Klik tab CLI Example di sisi kanan tab Parameters untuk melihat perintah contoh yang dihasilkan yang berisi parameter yang ditentukan.

Klik ikon Run Command untuk memulai Cloud Shell dan debug perintah di Cloud Shell.
Klik ikon untuk menyalin perintah contoh ke clipboard. Anda dapat menempelkan perintah tersebut ke alat shell Anda dan menjalankannya.
- Perhatikan format parameter saat menempelkan perintah contoh ke alat shell Anda. Untuk detail lebih lanjut tentang format parameter Alibaba Cloud CLI, lihat Format Parameter.
- Secara default, OpenAPI Explorer menambahkan opsi --region ke perintah CLI yang dihasilkan. Saat Anda menyalin perintah ke shell lokal Anda, Alibaba Cloud CLI mengabaikan informasi wilayah dalam konfigurasi kredensial default dan pengaturan variabel lingkungan, dan secara prioritas menggunakan wilayah yang ditentukan untuk menjalankan perintah. Anda dapat menghapus atau mempertahankan opsi ini sesuai kebutuhan bisnis Anda.

Langkah 4: Panggil Operasi API

Sintaks

Di Alibaba Cloud CLI, gunakan sintaks berikut untuk menjalankan perintah. Untuk detail lebih lanjut, lihat Hasilkan dan Jalankan Perintah CLI.

aliyun <command> <subcommand> [opsi dan parameter]

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>: Gunakan opsi --profile dan parameter profileName untuk menentukan profil konfigurasi. Setelah menentukan profil konfigurasi yang valid, CLI mengabaikan informasi dalam konfigurasi kredensial default dan pengaturan variabel lingkungan, serta menggunakan konfigurasi yang Anda tentukan untuk menjalankan perintah.
--help: Gunakan opsi --help untuk mendapatkan informasi bantuan tentang perintah. Untuk detail lebih lanjut, lihat Gunakan Perintah Bantuan.

Untuk detail lebih lanjut, lihat Opsi Baris Perintah.

Jalankan Perintah

Setelah perintah contoh dihasilkan, salin perintah tersebut dan tempelkan ke alat shell untuk menjalankannya. Sebagai contoh, jalankan perintah berikut untuk memanggil operasi CreateInstance dari Elastic Compute Service untuk membuat instance ECS dengan pembayaran sesuai pemakaian:

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 xxx

Untuk detail lebih lanjut tentang cara menjalankan perintah, lihat bagian "Contoh" dari topik Hasilkan dan Jalankan Perintah CLI atau topik CLI integration example dari setiap layanan Alibaba Cloud.