Gunakan Alibaba Cloud CLI untuk mendapatkan informasi bantuan - Alibaba Cloud CLI

Alibaba Cloud CLI terintegrasi dengan layanan Alibaba Cloud dan informasi API mereka. Anda dapat menambahkan opsi --help di Alibaba Cloud CLI untuk mendapatkan informasi bantuan.

Kueri layanan yang tersedia dan opsi global

Anda dapat menambahkan opsi --help pada perintah aliyun untuk menanyakan opsi perintah umum dan layanan yang didukung.

Jalankan perintah berikut:
```
aliyun --help
```

Contoh respons (sebagian):

shell@Alicloud:~$ aliyun --help
Alibaba Cloud CLI 3.0.276

Penggunaan:
  aliyun <produk> <operasi> [--parameter1 nilai1 --parameter2 nilai2 ...]

Bendera:
  --mode                    Gunakan `--mode {AK|StsToken|RamRoleArn|EcsRamRole|RsaKeyPair|RamRoleArnWithRoleName}` untuk menentukan metode autentikasi.
  --profile,-p              Gunakan `--profile <profileName>` untuk menentukan profil.
  ...
  --help                    Cetak informasi bantuan.

Contoh:
  aliyun ecs DescribeRegions

Produk:
  actiontrail                  ActionTrail
  adb                          AnalyticDB for MySQL
  adcp                         Distributed Cloud Container Platform for Kubernetes
  ...

Kueri operasi API yang tersedia untuk suatu layanan

Tambahkan opsi --help setelah kode layanan untuk menanyakan daftar operasi API yang tersedia dalam layanan tersebut. Deskripsi operasi API dalam gaya remote procedure call (RPC) ditampilkan. Endpoint dari operasi API dalam gaya arsitektur berorientasi sumber daya (ROA) juga ditampilkan.

Catatan

Alibaba Cloud CLI menggunakan indikator berikut sebelum deskripsi operasi untuk menunjukkan status atau karakteristik suatu operasi:

[Anonymous]: menunjukkan operasi anonim yang dapat dipanggil tanpa autentikasi. Untuk memanggil jenis operasi ini, lihat Pemanggilan generik.
[Deprecated]: menunjukkan bahwa operasi tersebut sudah tidak digunakan lagi. Kami sarankan Anda beralih ke versi terbaru dari operasi ini.

RPC

Jalankan perintah berikut untuk menanyakan operasi API yang tersedia di Elastic Compute Service (ECS):
```
aliyun ecs --help
```

Respons yang diharapkan:

shell@Alicloud:~$ aliyun ecs --help
Alibaba Cloud CLI 3.0.276

Penggunaan:
  aliyun ecs <ApiName> --parameter1 nilai1 --parameter2 nilai2 ...

Produk: Ecs (ECS)
Versi: 2014-05-26 

Daftar Api yang Tersedia: 
  AcceptInquiredSystemEvent                          Menerima dan mengotorisasi operasi pada peristiwa sistem. Untuk peristiwa sistem dalam status Inquiring, operasi ini menerima operasi default untuk peristiwa sistem dan mengizinkan sistem untuk melakukan operasi default. 
  ActivateRouterInterface                            [Tidak digunakan lagi] Mengaktifkan antarmuka router yang tidak aktif. 
  AddBandwidthPackageIps                             [Tidak digunakan lagi]
  AddTags                                            Menambahkan atau menimpa satu atau lebih tag untuk sumber daya ECS. Anda dapat menambahkan tag ke sumber daya ECS seperti instance, disk, snapshot, image, dan grup keamanan untuk manajemen yang mudah. 
  ...

ROA

Jalankan perintah berikut untuk menanyakan operasi API yang tersedia di Container Service for Kubernetes (ACK):
```
aliyun cs --help
```

Respons yang diharapkan:

shell@Alicloud:~$ aliyun cs --help
Alibaba Cloud CLI 3.0.276

Penggunaan 1:
  aliyun cs [GET|PUT|POST|DELETE] <PathPattern> --body "..." 

Penggunaan 2 (Untuk API tanpa PARAMS di PathPattern saja.):
  aliyun cs <ApiName> --parameter1 nilai1 --parameter2 nilai2 ... --body "..."

Produk: CS (ACK)
Versi: 2015-12-15 

Daftar Api yang Tersedia: 
  AttachInstances                         : POST /clusters/[ClusterId]/attach
  AttachInstancesToNodePool               : POST /clusters/[ClusterId]/nodepools/[NodepoolId]/attach
  CancelClusterUpgrade                    : POST /api/v2/clusters/[ClusterId]/upgrade/cancel
  CancelComponentUpgrade                  : POST /clusters/[clusterId]/components/[componentId]/cancel
  ...

Detail parameter API Kueri

Anda dapat menambahkan opsi --help setelah operasi API untuk menanyakan detail parameter, termasuk nama parameter dan tipe parameter. Metode permintaan dan endpoint dari operasi API bergaya ROA juga ditampilkan.

RPC

Jalankan perintah berikut untuk menanyakan detail parameter tentang operasi DescribeRegions dari Elastic Compute Service:
```
aliyun ecs DescribeRegions --help
```

Respons yang diharapkan:

shell@Alicloud:~$ aliyun ecs DescribeRegions --help
Alibaba Cloud CLI 3.0.276

Produk: Ecs (ECS)

Parameter:
  --AcceptLanguage String  Opsional

  Bahasa alami yang digunakan untuk memfilter respons. Untuk informasi lebih lanjut, lihat RFC7231 di https://tools.ietf.org/html/rfc7231. Nilai valid:   
           
  - zh-CN: Mandarin 
  - en-US: Inggris. 
  - ja: Jepang 
  
  Nilai default: zh-CN. 

  --InstanceChargeType String  Opsional

  Metode penagihan instance. Untuk informasi lebih lanjut, lihat Ikhtisar Penagihan. Nilai valid: 
  
  - PrePaid: langganan. Jika Anda mengatur parameter ini ke PrePaid, pastikan Anda memiliki saldo atau kredit yang cukup di akun Anda. Jika tidak, kode kesalahan InvalidPayMethod akan dikembalikan. 
  - PostPaid: bayar sesuai pemakaian. 
  
  Nilai default: PostPaid. 

  --ResourceType String  Opsional

  Jenis sumber daya. Nilai valid:
  -  instance: Instance ECS
  -  disk: disk
  -  reservedinstance: instance cadangan
  -  scu: unit kapasitas penyimpanan (SCU)
  
  Nilai default: instance

ROA

Jalankan perintah berikut untuk menanyakan detail parameter tentang operasi AttachInstances dari Container Service for Kubernetes:
```
aliyun cs AttachInstances --help
```

Respons yang diharapkan:

shell@Alicloud:~$ aliyun cs AttachInstances --help
Alibaba Cloud CLI 3.0.276

Produk:     CS (ACK)
Metode:      POST
PathPattern: /clusters/[ClusterId]/attach

Parameter:
  --ClusterId String  Wajib

  ID kluster. 

  --body Struct  Opsional

  Parameter body permintaan.