Alibaba Cloud CLI adalah alat command-line umum yang dikembangkan berdasarkan OpenAPI Explorer. Anda dapat menggunakan Alibaba Cloud CLI untuk menerapkan pengelolaan dan pemeliharaan otomatis terhadap resource ENS. Topik ini menjelaskan cara menggunakan Alibaba Cloud CLI untuk memanggil operasi API ENS.
Sebelum memulai
Pahami terlebih dahulu Alibaba Cloud CLI. Untuk informasi selengkapnya, lihat Apa itu Alibaba Cloud CLI?
Instal Alibaba Cloud CLI
Anda harus menginstal Alibaba Cloud CLI sebelum menggunakannya. Alibaba Cloud CLI dapat diinstal pada sistem operasi 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 yang disediakan oleh Alibaba Cloud untuk melakukan debugging perintah yang ingin dijalankan di Alibaba Cloud CLI. Untuk informasi selengkapnya tentang Cloud Shell, lihat Apa itu Cloud Shell?
Konfigurasi Alibaba Cloud CLI
Akun Alibaba Cloud memiliki izin untuk mengelola dan mengakses API semua layanan Alibaba Cloud. Jika Anda menggunakan Akun Alibaba Cloud untuk memanggil operasi API, risiko keamanan mungkin timbul. Kami menyarankan agar Anda membuat dan menggunakan Pengguna Resource Access Management (RAM) untuk memanggil operasi API atau melakukan operasi O&M rutin.
Sebelum menggunakan Alibaba Cloud CLI, Anda harus mengonfigurasi informasi seperti kredensial identitas dan ID wilayah. Alibaba Cloud CLI mendukung berbagai jenis kredensial identitas. Untuk informasi selengkapnya, lihat Jenis kredensial. Pada contoh ini, digunakan kredensial AccessKey.
-
Buat Pengguna RAM dan berikan izin yang diperlukan kepada pengguna tersebut. Untuk informasi selengkapnya, lihat Buat Pengguna RAM dan Berikan izin kepada Pengguna RAM.
PentingUntuk contoh ini, Anda harus memberikan kebijakan
AliyunENSFullAccesskepada Pengguna RAM. Kebijakan ini memberikan kontrol penuh untuk mengkueri dan memodifikasi instans ENS. Anda juga dapat memberikan kebijakanAliyunENSReadOnlyAccessatau kebijakan kustom sesuai kebutuhan. Untuk informasi selengkapnya, lihat Referensi kebijakan kustom ENS. -
Setelah membuat dan memberikan otorisasi kepada Pengguna RAM, buat Pasangan Kunci Akses (AccessKey pair) untuknya. Catat
ID AccessKeydanAccessKey Secretuntuk konfigurasi kredensial. Untuk informasi selengkapnya, lihat Buat Pasangan Kunci Akses. -
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 Titik akhir.
CatatanSaat menggunakan Alibaba Cloud CLI, Anda dapat menggunakan opsi
--regionuntuk menentukan wilayah untuk satu perintah tertentu. Opsi ini menggantikan pengaturan wilayah dalam konfigurasi kredensial default dan variabel lingkungan Anda. Untuk informasi selengkapnya, lihat Opsi perintah. -
Gunakan Pasangan Kunci Akses Pengguna RAM untuk mengonfigurasi kredensial berbasis AccessKey. Beri nama profil konfigurasi tersebut
AkProfile. Untuk informasi selengkapnya, lihat Konfigurasi dan kelola kredensial identitas.
Buat perintah CLI
-
Masuk ke halaman debugging API untuk ENS.
-
Pada halaman debugging API, gunakan kotak pencarian di sisi kiri untuk menemukan API yang ingin digunakan. Di bagian Parameter Configuration, isi parameter yang diperlukan. Lalu, klik tab CLI Example di samping bagian Parameter Configuration untuk menghasilkan contoh perintah.
Klik ikon
. Anda akan diarahkan ke Cloud Shell. Anda dapat melakukan debugging perintah di Cloud Shell.-
Klik ikon
untuk menyalin perintah CLI ke clipboard, lalu tempel perintah tersebut ke shell lokal.Saat menempel contoh perintah ke shell Anda untuk debugging, perhatikan format parameter. Untuk informasi selengkapnya tentang format parameter Alibaba Cloud CLI, lihat Format parameter.
-
Contoh yang dihasilkan oleh OpenAPI Explorer secara default menyertakan opsi
--region. Saat menjalankan perintah secara lokal, Alibaba Cloud CLI akan memprioritaskan opsi ini dan mengabaikan pengaturan wilayah dalam konfigurasi kredensial default serta variabel lingkungan Anda. Anda dapat menghapus atau tetap menyertakan opsi ini sesuai kebutuhan.
Panggil operasi API
Sintaksis
Di Alibaba Cloud CLI, Anda dapat menggunakan sintaksis berikut untuk menjalankan perintah. Untuk informasi selengkapnya, lihat Sintaksis.
aliyun <command> <subcommand> [options and parameters]Opsi perintah
Saat menggunakan Alibaba Cloud CLI, Anda dapat menentukan opsi perintah untuk mengubah perilaku perintah atau menerapkan fitur tambahan. Umumnya, opsi perintah berikut digunakan:
-
--profile <profileName>: Saat menggunakan opsi--profiledan menentukan nama konfigurasi yang validprofileName, Alibaba Cloud CLI akan mengabaikan konfigurasi kredensial identitas default dan variabel lingkungan, serta memprioritaskan konfigurasi yang ditentukan untuk menjalankan perintah. -
--help: Pada tingkat perintah apa pun, gunakan opsi--helpuntuk mendapatkan bantuan terkait perintah tersebut. Untuk informasi selengkapnya, lihat Dapatkan informasi bantuan.
Untuk informasi selengkapnya, lihat Opsi command line untuk pemanggilan API.
Contoh pemanggilan
Contoh berikut memanggil perintah RebootInstance di ENS untuk me-restart sebuah instans. Untuk informasi selengkapnya tentang perintah RebootInstance, lihat RebootInstance.
-
Jalankan perintah berikut:
aliyun ens RebootInstance --InstanceId i-5xxx8d3x --endpoint ens.aliyuncs.com -
Lihat output perintah.
{ "Code": "0", "RequestId": "845748BB-9E66-52DB-B4F5-4305601AD2CF" }
Jika terjadi kesalahan setelah Anda memanggil operasi API ENS, periksa apakah parameter input dan nilainya valid berdasarkan kode kesalahan.
Anda juga dapat mencatat ID permintaan dari respons atau pesan kesalahan SDK, lalu gunakan Alibaba Cloud OpenAPI Diagnostics untuk mendiagnosis masalah tersebut.