Alibaba Cloud CLI:Mengelola dan menggunakan plugin Alibaba Cloud CLI

Konvensi penamaan plugin

Plugin mengikuti format penamaan aliyun-cli-<ProductCode>, di mana kode produk sesuai dengan Alibaba Cloud OpenAPI:

Anda dapat menggunakan nama lengkap (aliyun-cli-ecs) atau kode produk (ecs). Nama tidak peka huruf besar/kecil.

Periksa dukungan CLI

Periksa apakah produk cloud memiliki plugin CLI:

• Kueri online (disarankan): Telusuri berdasarkan kategori, cari berdasarkan kata kunci, dan lihat contoh perintah di CLI Center.

• Kueri command-line: Daftar plugin yang tersedia atau cari berdasarkan kata kunci:

  • Daftar semua plugin di indeks remote:

    aliyun plugin list-remote

  • Contoh output:

    Total plugins available: 316
    
    Name                                     Latest Version  Preview  Status         Local Version  Description
    ----                                     --------------  -------  ------         -------------  -----------
    aliyun-cli-ecs                           0.1.0           No       Installed      0.1.0          Alibaba Cloud CLI plugin for ECS operations.
    aliyun-cli-fc                            0.1.0           No       Installed      0.1.0          Alibaba Cloud CLI plugin for FC 3.0 operations.
    aliyun-cli-acc                           0.1.0           No       Not installed  -              Alibaba Cloud CLI plugin for acs operations.

Cari plugin

Temukan plugin mana yang menyediakan perintah tertentu. Pencocokan awalan didukung.

# Cari plugin yang mengandung "ecs"
aliyun plugin search ecs
# Cari perintah di plugin ecs yang diawali dengan "describe"
aliyun plugin search "ecs describe"

Instal plugin

aliyun plugin install menerima plugin melalui --name (misalnya aliyun plugin install --name ecs) atau argumen posisional (misalnya aliyun plugin install ecs). Keduanya setara. --name ditambahkan di v3.3.14.

Contoh:

# Instal satu plugin berdasarkan nama
aliyun plugin install --name ecs

# Instal versi tertentu
aliyun plugin install --name fc --version 1.0.0

# Instal beberapa plugin sekaligus
aliyun plugin install --names ecs rds vpc

# Instal dari file arsip lokal (untuk lingkungan offline)
aliyun plugin install --package /path/to/ecs-plugin.zip

# Instal dari URL
aliyun plugin install --package https://example.com/plugins/ecs-plugin.tar.gz

Verifikasi dengan aliyun plugin list:

Name                Version             Description
----                -------             -----------
aliyun-cli-ecs      0.1.0               Aliyun CLI plugin for Elastic Compute Service operations.
aliyun-cli-fc       0.1.0               Aliyun CLI plugin for Function Compute 3.0 operations.

Perintah plugin menggunakan kebab-case. CLI meneruskan kredensial (AccessKey, STS Token), wilayah, dan timeout dari profil saat ini secara otomatis. Opsi global seperti --profile dan --region berlaku tanpa konfigurasi tambahan.

Format perintah:

aliyun <plugin-name> <Command> [--parameter-name value ...]

Contoh penggunaan

aliyun ecs --help

aliyun ecs describe-regions --help

......
  --accept-language         string, Filters the results by language. For more information, see[RFC
                            7231](https://tools.ietf.org/html/rfc7231). Valid values:
                            - zh-CN: Simplified Chinese.
                            - zh-TW: Traditional Chinese.
                            - en-US: English.
                            - ja: Japanese.
                            - fr: French.
                            - de: German.
                            - ko: Korean.
                            Default: en-US
  --instance-charge-type    string, The billing method for the instance. For more information, see https://help.aliyun.
                            com/document_detail/25398.html. Valid values:
                            - PrePaid: Subscription. If you use this method, make sure your account supports balance payments or credit payments.
                            Otherwise, an `InvalidPayMethod` error is reported.
                            - PostPaid: Pay-As-You-Go.
                            - SpotWithPriceLimit: A user-defined maximum price for a spot instance.
                            - SpotAsPriceGo: The system automatically bids for a spot instance at the Pay-As-You-Go price.
                            Default: PostPaid
......

aliyun ecs describe-regions --accept-language en-US

{
  "Regions": {
     "Region": [
	{
	   "LocalName": "China (Qingdao)",
	   "RegionEndpoint": "ecs.cn-qingdao.aliyuncs.com",
	   "RegionId": "cn-qingdao"
			},
	{
	   "LocalName": "China (Beijing)",
	   "RegionEndpoint": "ecs.cn-beijing.aliyuncs.com",
	   "RegionId": "cn-beijing"
	},
......

Penggunaan lanjutan

Name                Version             Description
----                -------             -----------
aliyun-cli-ecs      0.1.0               Alibaba Cloud CLI plugin for ECS operations.
aliyun-cli-ess      0.1.0               Alibaba Cloud CLI plugin for Auto Scaling operations with multi-version API support.
aliyun-cli-fc       0.1.0               Alibaba Cloud CLI plugin for FC 3.0 operations.

# Tambahkan variabel lingkungan dan terapkan
echo 'export ALIBABA_CLOUD_ESS_API_VERSION=2022-02-22' >> ~/.bashrc
source ~/.bashrc

Perbarui plugin

Perbarui plugin tertentu:

aliyun plugin update --name ecs

Perbarui semua plugin yang terinstal:

aliyun plugin update

Jika sudah berada di versi terbaru, CLI akan melaporkan bahwa pembaruan tidak diperlukan. Tambahkan --enable-pre untuk versi pra-rilis.

Verifikasi dengan aliyun plugin list.

Uninstal plugin

Hapus plugin:

aliyun plugin uninstall --name ecs

Verifikasi penghapusan dengan aliyun plugin list.

Aktifkan instalasi otomatis

Aktifkan melalui perintah:

aliyun configure set --auto-plugin-install true

Atau dengan variabel lingkungan:

echo 'export ALIBABA_CLOUD_CLI_PLUGIN_AUTO_INSTALL=true' >> ~/.bashrc
source ~/.bashrc

Verifikasi dengan aliyun configure get.

Izinkan instalasi otomatis versi pra-rilis:

aliyun configure set --auto-plugin-install-enable-pre true

Atau dengan variabel lingkungan:

echo 'export ALIBABA_CLOUD_CLI_PLUGIN_AUTO_INSTALL_ENABLE_PRE=true' >> ~/.bashrc
source ~/.bashrc

Kebijakan instalasi

Perilaku bervariasi berdasarkan lingkungan runtime:

Contoh output untuk instalasi otomatis:

# Jalankan perintah saat plugin ecs belum diinstal
aliyun ecs describe-regions --accept-language en-US
# Output proses instalasi otomatis
Plugin 'aliyun-cli-ecs' is required for command 'ecs describe-regions' but not installed.
Auto-installing plugin 'aliyun-cli-ecs' (including pre-release versions)...
Downloading aliyun-cli-ecs 0.1.0...
Plugin aliyun-cli-ecs 0.1.0 installed successfully!
......

Contoh output di lingkungan interaktif dengan instalasi otomatis dinonaktifkan:

# Jalankan perintah saat plugin ecs belum diinstal
aliyun ecs describe-regions --accept-language en-US
# Output proses instalasi interaktif
Plugin 'aliyun-cli-ecs' is required for command 'ecs describe-regions' but not installed.
Tip: Run 'aliyun configure set --auto-plugin-install true' to skip this prompt.
Do you want to install it? [Y/n]: y
Installing plugin 'aliyun-cli-ecs' (including pre-release versions)...
Downloading aliyun-cli-ecs 0.1.0...
Plugin aliyun-cli-ecs 0.1.0 installed successfully!
......

Lihat pengaturan saat ini

Lihat pengaturan saat ini:

aliyun configure plugin-settings show

Tetapkan sumber plugin khusus

Tetapkan URL sumber khusus:

aliyun configure plugin-settings set --source-base https://internal-mirror.example.com/cli-plugins

Verifikasi:

aliyun configure plugin-settings show

Hapus pengaturan khusus

Hapus pengaturan khusus dan kembalikan ke default:

aliyun configure plugin-settings clear

Prioritas URL sumber

CLI menyelesaikan URL sumber dengan memeriksa lokasi berikut secara berurutan (yang pertama cocok digunakan):

1. Flag --source-base pada perintah saat ini.

2. Variabel lingkungan ALIBABA_CLOUD_CLI_PLUGIN_SOURCE_BASE.

3. Nilai source-base di ~/.aliyun/plugin-settings.json.

4. URL default bawaan.

Daftar perintah plugin

Variabel lingkungan plugin

Variabel lingkungan untuk perilaku plugin:

Instalasi gagal: "no stable version available"

Plugin hanya memiliki versi pra-rilis. Tambahkan --enable-pre:

aliyun plugin install --name <plugin-name> --enable-pre