Alibaba Cloud CLI menggunakan struktur perintah berbasis plugin. Tambahkan --help untuk melihat perintah dan parameter yang tersedia. Diperlukan versi 3.3.0 atau lebih baru untuk pemuatan plugin otomatis. - Alibaba Cloud CLI

Alibaba Cloud CLI menggunakan struktur perintah berbasis plugin yang terpadu. Topik ini menjelaskan komponen-komponen suatu perintah dan cara menggunakan --help untuk dengan cepat melihat perintah dan parameter yang tersedia.

Prasyarat

Alibaba Cloud CLI versi 3.3.0 atau lebih baru telah diinstal. Untuk informasi selengkapnya, lihat Instal, update, dan uninstal Alibaba Cloud CLI.
Kredensial telah dikonfigurasi untuk Alibaba Cloud CLI. Untuk informasi selengkapnya, lihat Konfigurasikan dan kelola kredensial.

Format perintah

Format perintah CLI berbasis plugin

Struktur perintah umum untuk Alibaba Cloud CLI berbasis plugin adalah sebagai berikut:

aliyun <command> <sub-command> [parameters]

Penjelasan setiap komponen:

command: Perintah tingkat atas, yang dapat berupa salah satu dari dua jenis berikut:
- Perintah bawaan (tidak memerlukan instalasi plugin). Contohnya:
  - configure (konfigurasikan kredensial dan parameter default).
  - plugin (kelola plugin).
  - upgrade (upgrade CLI).
  Jalankan aliyun --help untuk melihat semua perintah bawaan.
- Nama plugin produk cloud. Contohnya, aliyun-cli-ecs, aliyun-cli-oss, aliyun-cli-cs, dan aliyun-cli-fc.
sub-command: Sub-perintah (SubCommand) yang menentukan operasi yang akan dilakukan.
- Jika perintah tingkat atas adalah perintah bawaan, jalankan aliyun <command> --help untuk melihat parameter atau sub-perintah yang tersedia.
- Jika perintah tingkat atas adalah plugin produk cloud, sub-perintah menggunakan penamaan kebab-case. Contohnya, describe-instances dan create-bucket.
parameters: Parameter perintah yang mengontrol perilaku Alibaba Cloud CLI atau menentukan parameter API. Untuk informasi lebih lanjut tentang format parameter, lihat Pahami parameter perintah.
- Parameter bisnis: Diawali dengan --. Contohnya, --instance-id i-xxx.
- Parameter global: Parameter umum yang memengaruhi perilaku keseluruhan perintah. Contohnya, --region cn-hangzhou dan --profile prod.

Contoh minimal

Perintah berikut mengkueri daftar wilayah yang dapat diakses oleh akun saat ini dan tidak memerlukan parameter tambahan:

aliyun ecs describe-regions

Pemuatan plugin sesuai permintaan

Plugin CLI merupakan kumpulan perintah produk cloud yang didistribusikan secara independen dan mendukung instalasi otomatis sesuai permintaan:

Daftar plugin yang telah diinstal:
```
aliyun plugin list
```

Instalasi otomatis saat pertama kali dijalankan (perilaku default untuk CLI ≥ 3.3.0):

# Jika plugin ecs belum diinstal, CLI akan mengunduh dan menyimpannya dalam cache secara otomatis.
aliyun ecs describe-instances

Instal plugin tertentu secara manual:
```
aliyun plugin install --names ecs
```

Untuk operasi manajemen plugin lainnya, lihat Kelola dan gunakan plugin Alibaba Cloud CLI.

Format perintah CLI lama (gaya OpenAPI)

Penting

Mulai versi 3.3.0, Alibaba Cloud CLI memperkenalkan perintah berbasis plugin (gaya kebab-case, seperti aliyun ecs describe-regions), menggantikan perintah PascalCase lama (seperti aliyun ecs DescribeRegions). Untuk memastikan kelengkapan fitur dan stabilitas jangka panjang, kami sangat menyarankan agar Anda memigrasikan skrip dan operasi harian yang ada ke perintah berbasis plugin.

Operasi OpenAPI Alibaba Cloud menggunakan dua gaya: RPC dan ROA. Sebagian besar layanan menggunakan gaya RPC. Metode pemanggilannya berbeda antara kedua gaya tersebut. Sebelum menggunakan perintah gaya OpenAPI lama, Anda perlu menentukan gaya API-nya. Secara umum, semua API dalam satu produk menggunakan gaya yang sama, dan setiap API hanya mendukung satu gaya tertentu. Untuk informasi selengkapnya tentang gaya RPC dan ROA, lihat Gaya OpenAPI.

Struktur perintah gaya RPC

Jika perintah tingkat atas adalah kode produk dan produk tersebut menggunakan gaya RPC, sub-perintah biasanya merupakan nama operasi OpenAPI. Struktur perintahnya adalah sebagai berikut:

aliyun <ProductCode> <APIName> [Parameters]

Contoh: Mengkueri daftar wilayah yang tersedia.

aliyun ecs DescribeRegions

Struktur perintah gaya ROA

Operasi OpenAPI bergaya ROA memerlukan metode HTTP tambahan Method dan path permintaan PathPattern. Struktur perintahnya adalah sebagai berikut:

aliyun <ProductCode> <Method> <PathPattern> [RequestBody] [Parameters]

Contoh berikut menunjukkan cara memanggil API Container Service for Kubernetes (ACK) DescribeClustersForRegion untuk mengkueri kluster khusus ACK di wilayah China (Hangzhou).

aliyun cs GET /regions/cn-hangzhou/clusters --cluster_type Kubernetes

Output bantuan untuk operasi OpenAPI bergaya ROA juga menampilkan metode HTTP Method dan path permintaan PathPattern untuk membantu memastikan format pemanggilan.

Menentukan gaya OpenAPI

Anda dapat menentukan gaya API dengan menggunakan metode berikut:

Tambahkan --help setelah aliyun <command> untuk mendapatkan daftar operasi OpenAPI yang tersedia. Output bantuan untuk operasi bergaya RPC menampilkan deskripsi operasi, sedangkan output bantuan untuk operasi bergaya ROA menampilkan path permintaan PathPattern. Contohnya:
```
# Gaya RPC
aliyun ecs --help
```
Tambahkan --help setelah aliyun <command> <sub-command> untuk melihat detail parameter. Output bantuan untuk operasi bergaya ROA juga menampilkan metode HTTP Method dan path permintaan PathPattern. Contohnya:
```
# Gaya ROA
aliyun cs AttachInstances --help
```

Catatan

Mulai CLI versi 3.3.0, setelah plugin produk cloud diinstal, aliyun <command> --help pada tingkat perintah akan menampilkan informasi bantuan plugin secara default. Untuk melihat bantuan asli, atur variabel lingkungan ALIBABA_CLOUD_ORIGINAL_PRODUCT_HELP=true. Perilaku aliyun <command> <sub-command> --help pada tingkat sub-perintah tetap tidak berubah.

Menggunakan bantuan perintah

Alibaba Cloud CLI menyediakan tiga tingkat penelusuran --help. Tambahkan --help setelah nama plugin (seperti ecs) atau sub-perintah untuk melihat daftar sub-perintah dan detail parameter yang tersedia.

Daftar perintah bawaan dan plugin yang didukung

aliyun --help

Daftar semua sub-perintah

aliyun ecs --help

Lihat detail parameter

Menampilkan daftar parameter, apakah setiap parameter wajib diisi, tipe data, nilai default, dan contoh untuk sub-perintah yang ditentukan:

aliyun ecs describe-instances --help

Penanda utama dalam output bantuan

Penanda	Deskripsi
`[Required]`	Parameter wajib
Anotasi tipe	Tipe data parameter, seperti String, Integer, Boolean, Array, atau JSON
Nilai default	Contohnya, `--output json` (default adalah json)
Cuplikan contoh	Umumnya terletak di akhir output bantuan, menunjukkan pola pemanggilan khas

Pertanyaan Umum

Menjalankan perintah menghasilkan "Command not found"

Kesalahan ini menunjukkan bahwa plugin produk cloud yang sesuai belum diinstal. CLI ≥ 3.3.0 mendukung instalasi otomatis saat pertama kali dijalankan. Jika instalasi otomatis gagal karena pembatasan jaringan, jalankan perintah berikut secara manual untuk menginstal plugin:

aliyun plugin install --names ecs

Bagaimana cara melihat parameter yang didukung oleh sub-perintah?

Jalankan aliyun <command> <sub-command> --help untuk melihat daftar parameter lengkap.