Hasilkan perintah CLI di OpenAPI Explorer - Alibaba Cloud CLI

Alibaba Cloud CLI mendukung berbagai layanan Alibaba Cloud. Topik ini menjelaskan cara menggunakan perintah Alibaba Cloud CLI untuk memanggil operasi API yang umum digunakan serta cara menghasilkan perintah CLI di OpenAPI Explorer.

Prasyarat

Penting

Anda mungkin dikenai biaya saat memanggil beberapa operasi API. Sebelum men-debug perintah, pastikan Anda telah mengaktifkan layanan Alibaba Cloud yang diperlukan, memahami aturan penagihan layanan tersebut, serta cara memanggil operasi API-nya.

Sebelum men-debug perintah secara lokal, pastikan Anda telah menginstal Alibaba Cloud CLI dan mengonfigurasi kredensial identitas dengan benar. Untuk informasi selengkapnya, lihat Installation Guide dan Configure identity credentials.
Anda dapat memperoleh referensi API suatu layanan Alibaba Cloud beserta contoh kode perintah Alibaba Cloud CLI yang sesuai di OpenAPI Explorer berdasarkan nama layanan tersebut. Untuk informasi selengkapnya, lihat bagian Generate a command dalam topik ini.

Hasilkan perintah

Catatan

OpenAPI Explorer dapat menghasilkan semua perintah Alibaba Cloud CLI secara online. Kami menyarankan Anda mengikuti langkah-langkah berikut untuk menghasilkan perintah CLI.

Langkah 1: Masuk ke OpenAPI Explorer

Masuk ke OpenAPI Explorer.

Langkah 2: Cari operasi API yang ingin Anda hasilkan perintah CLI-nya

Anda dapat menggunakan salah satu metode berikut untuk mencari operasi API di OpenAPI Explorer:

Cari berdasarkan nama operasi API

Penting

Layanan Alibaba Cloud yang berbeda mungkin menggunakan operasi API dengan nama yang sama. Identifikasi nama operasi API dengan cermat untuk mencegah kerugian akibat operasi yang tidak disengaja.

Di OpenAPI Explorer, masukkan nama operasi API yang ingin Anda panggil di kotak pencarian atas atau tengah, arahkan pointer ke operasi API tersebut, lalu klik Debug.

Cari berdasarkan kode layanan

Di OpenAPI Explorer, masukkan kode layanan Alibaba Cloud yang operasi API-nya ingin Anda panggil di kotak pencarian atas atau tengah, arahkan pointer ke layanan tersebut, lalu klik View API untuk menuju halaman utama layanan tersebut.

Anda juga dapat mengarahkan pointer ke Cloud Products di bilah navigasi atas OpenAPI Explorer dan mencari layanan Alibaba Cloud tempat operasi API tersebut berada untuk menuju halaman utama layanan tersebut.
Di halaman utama layanan tersebut, klik Debug di pojok kanan atas.

Langkah 3: Hasilkan perintah CLI

Di kotak pencarian sebelah kiri, cari operasi API yang ingin Anda panggil. Di panel konfigurasi operasi API yang Anda pilih, klik tab Parameters dan konfigurasikan parameter sesuai dengan referensi API. Selanjutnya, perintah CLI dengan parameter yang ditentukan akan ditampilkan di tab CLI Example pada panel sebelah kanan.

Klik ikon untuk menjalankan dan men-debug perintah di Cloud Shell. Untuk informasi selengkapnya, lihat What is Cloud Shell?
Klik ikon untuk menyalin perintah CLI ke clipboard dan tempelkan ke shell lokal Anda.
- Perhatikan format parameter saat menyalin dan menempelkan perintah CLI ke shell lokal. Untuk informasi selengkapnya tentang format parameter yang diperlukan oleh Alibaba Cloud CLI, lihat Parameter formats.
- Secara default, OpenAPI Explorer menambahkan opsi --region ke perintah CLI yang dihasilkan. Saat Anda menyalin perintah tersebut ke shell lokal, Alibaba Cloud CLI akan mengabaikan informasi wilayah dalam konfigurasi kredensial identitas default dan pengaturan variabel lingkungan, serta menggunakan wilayah yang ditentukan secara prioritas untuk menjalankan perintah. Anda dapat menghapus atau mempertahankan opsi ini sesuai kebutuhan bisnis Anda.

Contoh

Kode contoh berikut memanggil operasi CreateInstance dari Elastic Compute Service menggunakan Alibaba Cloud CLI untuk membuat instans ECS dengan model bayar sesuai penggunaan. Untuk informasi selengkapnya tentang perintah Alibaba Cloud CLI, lihat bagian Generate a command dalam topik ini.

Jalankan perintah.

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

Hasilkan output.

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "InstanceId": "i-bp67acfmxazb4p****",
  "OrderId": "1234567890",
  "TradePrice": 0.165
}

Periksa apakah instans ECS telah dibuat melalui operasi API, SDK, atau Konsol Elastic Compute Service.