Alibaba Cloud CLI は、プラグインベースのコマンド構造を使用します。--help を追加して、利用可能なコマンドとパラメーターを表示します。プラグインの自動読み込みには、バージョン 3.3.0 以降が必要です。 - Alibaba Cloud CLI

Alibaba Cloud CLI は、統一されたプラグインベースのコマンド構造を使用しています。このトピックでは、コマンドの構成要素と、--help を使用して利用可能なコマンドとパラメーターを素早く表示する方法について説明します。

前提条件

Alibaba Cloud CLI 3.3.0 以降がインストールされていること。詳細については、「Alibaba Cloud CLI のインストール、更新、アンインストール」をご参照ください。
Alibaba Cloud CLI の認証情報が設定されていること。詳細については、「認証情報の設定と管理」をご参照ください。

コマンド形式

プラグインベースの CLI コマンド形式

プラグインベースの Alibaba Cloud CLI の一般的なコマンド構造は次のとおりです。

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

各コンポーネントの説明は次のとおりです。

コマンド: トップレベルコマンドで、次の 2 種類のいずれかです。
- 組み込みコマンド (プラグインのインストールは不要)。例：
  - configure （認証情報およびデフォルトパラメーターを設定します）。
  - plugin (プラグインを管理する)。
  - upgrade (CLI をアップグレードする)。
  aliyun --help を実行すると、すべての組み込みコマンドが表示されます。
- クラウド製品プラグイン名。たとえば、 aliyun-cli-ecs、 aliyun-cli-oss、 aliyun-cli-cs、 aliyun-cli-fc などです。
sub-command: 実行する操作を指定するサブコマンド (SubCommand) です。
- トップレベルコマンドが組み込みコマンドの場合、 aliyun <command> --help を実行して、使用可能なパラメーターまたはサブコマンドを確認できます。
- トップレベルコマンドがクラウド製品プラグインの場合、サブコマンドにはケバブケースが使用されます。たとえば、describe-instances や create-bucket などです。
parameters: Alibaba Cloud CLI の動作を制御するか、API パラメーターを指定するコマンドパラメーターです。パラメーター形式の詳細については、「コマンドパラメーターについて」をご参照ください。
- ビジネスパラメーターは -- で始まります。例: --instance-id i-xxx。
- グローバルパラメーター: コマンド全体の動作に影響を与える共通パラメーターです。たとえば、--region cn-hangzhou や --profile prod などです。

最小限の例

次のコマンドは、現在のアカウントがアクセスできるリージョンの一覧を照会します。追加のパラメーターは不要です。

aliyun ecs describe-regions

プラグインのオンデマンド読み込み

CLI プラグインは、オンデマンドでの自動インストールをサポートする、独立して配布されるクラウド製品のコマンドセットです。

インストール済みプラグインの一覧表示：
```
aliyun plugin list
```

初回実行時の自動インストール (CLI 3.3.0 以降のデフォルトの動作)：

# ecs プラグインがインストールされていない場合、CLI は自動的にダウンロードしてキャッシュします。
aliyun ecs describe-instances

特定のプラグインの手動インストール：
```
aliyun plugin install --names ecs
```

プラグイン管理の詳細な操作については、「Alibaba Cloud CLI プラグインの管理と使用」をご参照ください。

レガシー CLI コマンド形式 (OpenAPI スタイル)

重要

バージョン 3.3.0 以降、Alibaba Cloud CLI では、従来の PascalCase コマンド (例: aliyun ecs DescribeRegions) に代わって、プラグインベースのコマンド (ケバブケーススタイル、例: aliyun ecs describe-regions) が導入されました。機能の完全性と長期的な安定性を確保するために、既存のスクリプトと日常の操作をプラグインベースのコマンドに移行することを強く推奨します。

Alibaba Cloud の OpenAPI 操作には、RPC と ROA の 2 つのスタイルがあります。ほとんどのサービスは RPC スタイルを使用します。呼び出し方法は 2 つのスタイルで異なります。レガシーな OpenAPI スタイルのコマンドを使用する前に、API スタイルを判断する必要があります。一般的に、1 つの製品内のすべての API は同じスタイルを使用し、各 API は1つのスタイルのみをサポートします。RPC および ROA スタイルの詳細については、「OpenAPI スタイル」をご参照ください。

RPC スタイルのコマンド構造

トップレベルコマンドがプロダクトコードで、その製品が RPC スタイルを使用する場合、サブコマンドは通常、OpenAPI の操作名になります。コマンド構造は次のとおりです。

aliyun <ProductCode> <APIName> [Parameters]

例：利用可能なリージョンの一覧を照会します。

aliyun ecs DescribeRegions

ROA スタイルのコマンド構造

ROA スタイルの OpenAPI 操作では、追加の HTTP メソッド Method とリクエストパス PathPattern が必要です。コマンド構文は次のとおりです。

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

次の例では、Container Service for Kubernetes (ACK) の DescribeClustersForRegion API を呼び出して、中国 (杭州) リージョン内の ACK 専用クラスターを照会する方法について説明します。

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

ROA スタイルの OpenAPI 操作のヘルプ出力には、呼び出し形式を確認できるよう、HTTP メソッド Method とリクエストパス PathPattern が追加で表示されます。

OpenAPI スタイルの判別

以下の方法で API スタイルを判別できます。

aliyun <command> の後に --help を追加すると、利用可能な OpenAPI 操作のリストを取得できます。 RPC スタイル操作のヘルプ出力には操作の説明が表示され、ROA スタイル操作のヘルプ出力にはリクエストパス PathPattern が表示されます。例:
```
# RPC スタイル
aliyun ecs --help
```
aliyun <command> <sub-command> の後に --help を追加すると、パラメーターの詳細を表示できます。 ROA スタイルの操作のヘルプ出力には、HTTP メソッド Method とリクエストパス PathPattern も表示されます。例:
```
# ROA スタイル
aliyun cs AttachInstances --help
```

説明

CLI 3.3.0 以降、クラウド製品プラグインをインストールすると、コマンドレベルの aliyun <command> --help はデフォルトでプラグインのヘルプ情報を表示します。元のヘルプを表示するには、環境変数 ALIBABA_CLOUD_ORIGINAL_PRODUCT_HELP=true を設定します。サブコマンドレベルの aliyun <command> <sub-command> --help の動作は変更されません。

コマンドヘルプの使用

Alibaba Cloud CLI は 3 段階の --help ドリルダウンを提供しており、プラグイン名 (ecs など) またはサブコマンドの後に --help を追加することで、利用可能なサブコマンドリストとパラメーターの詳細を表示できます。

組み込みコマンドとサポートされているプラグインの一覧表示

aliyun --help

すべてのサブコマンドの一覧表示

aliyun ecs --help

パラメーターの詳細表示

指定されたサブコマンドのパラメーターの一覧、各パラメーターが必須かどうか、データ型、デフォルト値、および使用例が表示されます。

aliyun ecs describe-instances --help

ヘルプ出力の主要なマーカー

マーカー	説明
`[必須]`	必須パラメーター
型注釈	パラメーターのデータ型。文字列、整数、ブール値、配列、または JSON。
デフォルト値	たとえば、`--output json` (デフォルトは json)
スニペット例	通常、ヘルプ出力の最後にあり、典型的な呼び出しパターンを示します。

よくある質問

コマンド実行時の「コマンドが見つかりません」エラー

このエラーは、対応するクラウド製品プラグインがインストールされていないことを示します。CLI 3.3.0 以降は、初回実行時の自動インストールをサポートしています。ネットワークの制約により自動インストールが失敗した場合は、次のコマンドを手動で実行してプラグインをインストールしてください。

aliyun plugin install --names ecs

サブコマンドでサポートされているパラメーターを表示するにはどうすればよいですか？

aliyun <command> <sub-command> --help を実行すると、すべてのパラメーターリストを表示できます。