Alibaba Cloud CLI:Memahami parameter perintah Alibaba Cloud CLI

Global flags

Flag berikut berlaku untuk semua perintah plugin, termasuk menentukan wilayah, melakukan pagination pada hasil kueri, dan mengaktifkan mode dry-run:

Business parameters

Business parameters adalah bidang permintaan yang diteruskan ke subperintah. Operasi yang berbeda memiliki parameter bisnis yang berbeda pula.

aliyun ecs describe-instances --biz-region-id cn-hangzhou --cli-dry-run

Tipe data parameter bisnis ditentukan oleh API. Tipe umum meliputi:

• String: String teks, seperti ID instans atau nama.

• Integer: Bilangan bulat, seperti nomor halaman atau jumlah.

• Boolean: Nilai Boolean true atau false.

• Array / JSON: Array atau objek JSON, seperti daftar ID disk atau objek tag.

Gunakan informasi bantuan CLI

Tambahkan --help ke perintah untuk melihat semua parameter yang didukung beserta deskripsinya. Format output bantuan bervariasi tergantung jenis perintah.

Perintah bawaan

Perintah bawaan terintegrasi ke dalam program inti Alibaba Cloud CLI dan dapat digunakan langsung tanpa menginstal plugin tambahan, seperti configure. Output bantuan untuk perintah bawaan menampilkan subperintah atau opsi spesifik:

aliyun configure --help

Output bantuan:

configure credential and settings

Usage:
  aliyun configure --mode {AK|RamRoleArn|EcsRamRole|OIDC|External|CredentialsURI|ChainableRamRoleArn|CloudSSO|OAuth} --profile <profileName> [--config-path <configPath>]

Commands:
  get             print configuration values
  set             set config in non interactive mode
  list            list all config profile
  delete          delete the specified profile
  switch          switch default profile
  safety-policy   manage safety policy and human-in-the-loop rules
  ai-mode         manage global AI mode and User-Agent for API calls
  plugin-settings manage global plugin system settings

Perintah plugin

Output bantuan untuk perintah plugin layanan cloud menampilkan nama parameter dalam format kebab-case, termasuk tipe parameter dan nilai default:

aliyun ecs describe-instances --help

Output bantuan:

Description: Queries a list of instances and their details based on specified conditions

API Version: 2014-05-26

Usage:
  aliyun ecs describe-instances [parameters]

Parameters:
  --biz-region-id                string (required), The ID of the region where the
                                 instance resides. You can call https://help.aliyun.
                                 com/document_detail/25609.html to query the latest
                                 list of Alibaba Cloud regions
  --additional-attributes        list, The list of other instance attributes
                                 format: --additional-attributes value1 value2 value3
  --device-available             bool, > This parameter is in invitational preview
                                 and is not available for use
......

Global Flags:
  --cli-ai-mode             bool, For this run, enable AI-mode
  --cli-dry-run             bool, Enable dry-run mode: print request details
                            without sending the actual API call
  --cli-query               string, Use `--cli-query <jmespath>` to filter
                            output with JMESPath expression
  --endpoint                string, Override service endpoint (e.g., --endpoint
                            https://ecs.cn-hangzhou.aliyuncs.com)
......

Examples:
  aliyun ecs describe-instances --biz-region-id example-value
  aliyun ecs describe-instances --biz-region-id example-value --vpc-id example-value

aliyun ecs DescribeInstances --help

Product: Ecs (Elastic Compute Service)

Parameters:
  --RegionId String  Required

  The region ID of the instance. You can call the [DescribeRegions](~~25609~~) operation to query the most recent region list.

  --AdditionalAttributes.n RepeatList Optional

  The additional instance attributes.
......

Gunakan portal OpenAPI

Portal OpenAPI Alibaba Cloud memungkinkan Anda melakukan debugging API secara online dan secara otomatis menghasilkan contoh perintah CLI. Untuk informasi selengkapnya, lihat Generate and run CLI commands with OpenAPI Explorer.

Nilai parameter tipe umum

Sistem operasi dan lingkungan terminal yang berbeda menangani tanda kutip secara berbeda. Saat meneruskan nilai parameter yang mengandung karakter khusus, gunakan aturan tanda kutip berikut:

Nilai parameter JSON

Beberapa parameter perintah memerlukan nilai dalam format JSON. Pemilihan tanda kutip luar dan dalam bervariasi tergantung sistem operasi.

Nilai yang mengandung karakter khusus

aliyun ecs AuthorizeSecurityGroup --SecurityGroupId 'sg-bp67acfmxazb4p****' --Permissions.1.PortRange "-1/-1" --method POST --force

aliyun ecs AuthorizeSecurityGroup --SecurityGroupId 'sg-bp67acfmxazb4p****' --Permissions.1.PortRange=-1/-1 --method POST --force

# Linux/macOS/PowerShell
aliyun ecs describe-images --image-name 'Example Image'
# Windows CMD
aliyun ecs describe-images --image-name "Example Image"

# Linux/macOS
aliyun xxx --param '$literal_dollar'

Muat nilai parameter dari file

Saat nilai parameter panjang, seperti Sertifikat atau muatan JSON besar, lebih praktis memuat nilainya dari file lokal.

aliyun cs PUT /clusters/c1234****/nodepools/np5678**** --body-file request.json

# Substitusi perintah
aliyun cs PUT /clusters/c1234****/nodepools/np5678**** --body "$(cat request.json)"

# Here-doc (cocok untuk membuat JSON inline dalam skrip)
aliyun cs PUT /clusters/c1234****/nodepools/np5678**** --body "$(cat <<EOF
{
  "nodepool_info": {
    "name": "default-nodepool",
    "resource_group_id": "rg-acfmyvw****"
  }
}
EOF
)"

--help menampilkan parameter sebagai Optional. Apakah saya selalu boleh mengabaikannya?

Tidak selalu. Beberapa perintah memiliki parameter yang saling eksklusif, artinya Anda harus menentukan salah satu dari keduanya. Parameter tersebut masing-masing ditandai sebagai opsional, tetapi setidaknya satu di antaranya harus ditentukan. Jika tidak, akan dikembalikan error. Untuk aturan persyaratan spesifik, rujuk dokumentasi API produk terkait.