Alibaba Cloud CLI uses a plugin-based command structure. Append --help to view available commands and parameters. Version 3.3.0 or later is required for auto plugin loading. - Alibaba Cloud CLI

Önkoşullar

Alibaba Cloud CLI sürüm 3.3.0 veya üzeri yüklenmiştir. Daha fazla bilgi için bkz. Alibaba Cloud CLI'yi yükleme, güncelleme ve kaldırma.
Alibaba Cloud CLI için bir kimlik bilgisi yapılandırılmıştır. Daha fazla bilgi için bkz. Kimlik bilgilerini yapılandırma ve yönetme.

Komut biçimi

Eklenti tabanlı CLI komut biçimi

Eklenti tabanlı Alibaba Cloud CLI için genel komut yapısı aşağıdaki gibidir:

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

Her bir bileşenin açıklaması:

command: Üst düzey komut; aşağıdaki iki türden biri olabilir:
- Yerleşik komutlar (eklenti kurulumu gerekmez). Örneğin:
  - configure (kimlik bilgilerini ve varsayılan parametreleri yapılandırır).
  - plugin (eklentileri yönetir).
  - upgrade (CLI'yi yükseltir).
  Tüm yerleşik komutları görüntülemek için aliyun --help komutunu çalıştırın.
- Cloud ürün eklenti adları. Örneğin, aliyun-cli-ecs, aliyun-cli-oss, aliyun-cli-cs ve aliyun-cli-fc.
sub-command: Gerçekleştirilecek işlemi belirten alt komut (SubCommand).
- Üst düzey komut yerleşik bir komut olduğunda, mevcut parametreleri veya alt komutları görüntülemek için aliyun <command> --help komutunu çalıştırın.
- Üst düzey komut bir cloud ürün eklentisi olduğunda, alt komutlar kebab-case adlandırma kuralını kullanır. Örneğin, describe-instances ve create-bucket.
parameters: Alibaba Cloud CLI'nin davranışını kontrol eden veya API parametrelerini belirten komut parametreleri. Parametre biçimleri hakkında daha fazla bilgi için bkz. Komut parametrelerini anlama.
- İş parametreleri: -- öneki ile başlar. Örneğin, --instance-id i-xxx.
- Genel parametreler: Genel komut davranışını etkileyen ortak parametrelerdir. Örneğin, --region cn-hangzhou ve --profile prod.

Minimal örnek

Aşağıdaki komut, mevcut hesap için erişilebilir bölgelerin listesini sorgular ve ek parametre gerektirmez:

aliyun ecs describe-regions

İhtiyaç üzerine eklenti yükleme

CLI eklentileri, otomatik ihtiyaç bazlı kurulumu destekleyen bağımsız olarak dağıtılan cloud ürün komut kümeleridir:

Yüklenen eklentileri listeleyin:
```
aliyun plugin list
```

İlk çalıştırmada otomatik kurulum (CLI ≥ 3.3.0 için varsayılan davranış):

# If the ecs plugin is not installed, the CLI downloads and caches it automatically.
aliyun ecs describe-instances

Belirli bir eklentiyi manuel olarak yükleyin:
```
aliyun plugin install --names ecs
```

Daha fazla eklenti yönetimi işlemi için bkz. Alibaba Cloud CLI eklentilerini yönetme ve kullanma.

Eski CLI komut biçimi (OpenAPI stili)

Önemli

Sürüm 3.3.0'dan başlayarak, Alibaba Cloud CLI, eski PascalCase komutlarının (örneğin, aliyun ecs DescribeRegions) yerine eklenti tabanlı komutları (kebab-case stili, örneğin aliyun ecs describe-regions) tanıttı. Özellik bütünlüğünü ve uzun vadeli kararlılığı sağlamak amacıyla, mevcut betikleri ve günlük işlemleri eklenti tabanlı komutlara geçirmenizi şiddetle öneririz.

Alibaba Cloud OpenAPI işlemleri iki stil kullanır: RPC ve ROA. Çoğu hizmet RPC stilini kullanır. Çağrı yöntemi iki stil arasında farklılık gösterir. Eski OpenAPI stili komutları kullanmadan önce API stilini belirlemeniz gerekir. Genel olarak, bir ürün içindeki tüm API'ler aynı stili kullanır ve her API yalnızca belirli bir stili destekler. RPC ve ROA stilleri hakkında daha fazla bilgi için bkz. OpenAPI stilleri.

RPC stili komut yapısı

Üst düzey komut bir ürün kodu olduğunda ve ürün RPC stilini kullandığında, alt komut genellikle OpenAPI işlem adıdır. Komut yapısı aşağıdaki gibidir:

aliyun <ProductCode> <APIName> [Parameters]

Örnek: Kullanılabilir bölgelerin listesini sorgulayın.

aliyun ecs DescribeRegions

ROA stili komut yapısı

ROA stili OpenAPI işlemleri, ek bir HTTP yöntemi Method ve istek yolu PathPattern gerektirir. Komut yapısı aşağıdaki gibidir:

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

Aşağıdaki örnekte, Çin (Hangzhou) bölgesindeki ACK özel kümelerini sorgulamak için Container Service for Kubernetes (ACK) DescribeClustersForRegion API'sinin nasıl çağrılacağı gösterilmektedir.

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

ROA stili OpenAPI işlemleri için yardım çıktısı, çağrı formatını doğrulamaya yardımcı olmak üzere HTTP yöntemi Method ve istek yolu PathPattern bilgilerini de gösterir.

OpenAPI stilini belirleme

API stilini aşağıdaki yöntemlerle belirleyebilirsiniz:

Mevcut OpenAPI işlemlerinin listesini almak için aliyun <command> sonrasında --help ekleyin. RPC stili işlemlerin yardım çıktısı işlem açıklamalarını gösterirken, ROA stili işlemlerin yardım çıktısı istek yolunu PathPattern gösterir. Örneğin:
```
# RPC style
aliyun ecs --help
```
Parametre ayrıntılarını görüntülemek için aliyun <command> <sub-command> sonrasında --help ekleyin. ROA stili işlemlerin yardım çıktısı ayrıca HTTP yöntemi Method ve istek yolunu PathPattern gösterir. Örneğin:
```
# ROA style
aliyun cs AttachInstances --help
```

Not

CLI 3.3.0'dan başlayarak, bir cloud ürün eklentisi yüklendikten sonra komut düzeyindeki aliyun <command> --help varsayılan olarak eklenti yardım bilgilerini gösterir. Orijinal yardımı görüntülemek için ALIBABA_CLOUD_ORIGINAL_PRODUCT_HELP=true ortam değişkenini ayarlayın. Alt komut düzeyindeki aliyun <command> <sub-command> --help davranışı değişmeden kalır.

Komut yardımını kullanma

Alibaba Cloud CLI, üç düzeyde --help detaylandırma sağlar. Mevcut alt komut listesini ve parametre ayrıntılarını görüntülemek için bir eklenti adından (örneğin ecs) veya bir alt komuttan sonra --help ekleyin.

Yerleşik komutları ve desteklenen eklentileri listeleme

aliyun --help

Tüm alt komutları listeleme

aliyun ecs --help

Parametre ayrıntılarını görüntüleme

Belirtilen alt komut için parametre listesini, her parametrenin zorunlu olup olmadığını, veri türünü, varsayılan değeri ve örnekleri gösterir:

aliyun ecs describe-instances --help

Yardım çıktısındaki ana işaretçiler

İşaretçi	Açıklama
`[Required]`	Zorunlu parametre
Tür ek açıklaması	Parametre veri türü, örneğin String, Integer, Boolean, Array veya JSON
Varsayılan değer	Örneğin, `--output json` (varsayılan json)
Örnek kod parçacığı	Genellikle yardım çıktısının sonunda yer alır ve tipik çağrı kalıplarını gösterir

SSS

Bir komutu çalıştırdığınızda "Command not found" hatası alınıyor

Bu hata, ilgili cloud ürün eklentisinin yüklü olmadığını gösterir. CLI ≥ 3.3.0, ilk çalıştırmada otomatik kurulumu destekler. Ağ kısıtlamaları nedeniyle otomatik kurulum başarısız olursa, eklentiyi yüklemek için aşağıdaki komutu manuel olarak çalıştırın:

aliyun plugin install --names ecs

Bir alt komutun desteklediği parametreler nasıl görüntülenir

Tam parametre listesini görüntülemek için aliyun <command> <sub-command> --help komutunu çalıştırın.