Alibaba Cloud CLI:プラグインの管理と使用

プラグインは、各クラウドプロダクトの API 呼び出し機能をスタンドアロンの実行可能プログラムにパッケージ化し、CLI コアによって一元的にスケジューリングされます。主な特徴は次のとおりです：

• オンデマンドインストール：必要なプラグインのみをインストールして、CLI のサイズを削減できます。

• 独立した更新：プラグインは独立してバージョンをリリースします。CLI コアをアップグレードする必要はありません。

• 一貫した命名：コマンドとパラメーターは、describe-instances や --accept-language のようにケバブケースを使用します。

• パラメーターの簡素化：低レベルのパラメーターは自動的にシリアル化されます。キーと値のペアで入力できます。

• 完全なヘルプ：--help コマンドを実行して、パラメーターの型、説明、および必須かどうかを確認できます。

プラグインは ~/.aliyun/plugins ディレクトリにインストールされます。manifest.json ファイルには、インストール済みのプラグインがリストされています。

プラグインの命名規則

プラグイン名は aliyun-cli-<product-code> というフォーマットに従います。プロダクトコードは Alibaba Cloud OpenAPI のプロダクトコードと同じです。例は次のとおりです：

プラグインのインストール、アンインストール、または更新時には、aliyun-cli-ecs のような完全なプラグイン名、または ecs のようなプロダクトコードを使用できます。名前は大文字と小文字を区別しません。

プラグインの表示と検索

リモートインデックスで利用可能なすべてのプラグインを表示できます：

aliyun plugin list-remote

次のサンプル出力が返されます：

Total plugins available: 316

Name                                     Latest Version  Preview  Status         Local Version  Description
----                                     --------------  -------  ------         -------------  -----------
aliyun-cli-ecs                           0.1.0           No       Installed      0.1.0          Aliyun CLI plugin for Elastic Compute Service operations.
aliyun-cli-fc                            0.1.0           No       Installed      0.1.0          Aliyun CLI plugin for Function Compute 3.0 operations.
aliyun-cli-acc                           0.1.0           No       Not installed  -              Aliyun CLI plugin for acs operations.

特定のコマンドを含むプラグインを見つけるには、検索機能を使用できます。検索機能はプレフィックスマッチングをサポートしています。

# ecs を含むプラグインを検索
aliyun plugin search ecs
# ecs プロダクトで describe で始まるコマンドを検索
aliyun plugin search "ecs describe"

インストールの実行

次のコマンドを実行してプラグインをインストールします：

aliyun plugin install --names ecs

インストールが完了したら、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.

必要に応じて、次のオプションパラメーターを使用できます：

プロダクトプラグインはケバブケースの命名規則を使用します。CLI は、AccessKey や STS トークンなどの認証情報、および現在のプロファイルからのリージョンとタイムアウト設定をプラグインに渡します。--profile や --region などのオプションもプラグインコマンドで利用できます。個別の設定を行う必要はありません。

コマンドのフォーマットは次のとおりです：

aliyun <product-code> <command> [--parameter-name value ...]

使用例

aliyun ecs --help

aliyun ecs describe-regions --help

......
  --accept-language         string, Filter results by Chinese, English, or Japanese. 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 value: zh-CN
  --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. Confirm your account supports balance payment or credit payment. Otherwise, the error InvalidPayMethod occurs.
                            - PostPaid: Pay-as-you-go.
                            - SpotWithPriceLimit: Set a maximum price.
                            - SpotAsPriceGo: Let the system set the bid. The highest price is the pay-as-you-go price.
                            Default value: PostPaid
......

aliyun ecs describe-regions --accept-language zh-CN

{
  "Regions": {
     "Region": [
	{
	   "LocalName": "中国 (青島)",
	   "RegionEndpoint": "ecs.cn-qingdao.aliyuncs.com",
	   "RegionId": "cn-qingdao"
			},
	{
	   "LocalName": "中国 (北京)",
	   "RegionEndpoint": "ecs.cn-beijing.aliyuncs.com",
	   "RegionId": "cn-beijing"
	},
......

高度な使用方法

Name                Version             Description
----                -------             -----------
aliyun-cli-ecs      0.1.0               Aliyun CLI plugin for Elastic Compute Service operations.
aliyun-cli-ess      0.1.0               Aliyun CLI plugin for Auto Scaling operations with multi-version API support.
aliyun-cli-fc       0.1.0               Aliyun CLI plugin for Function Compute 3.0 operations.

# 環境変数を追加して適用する
echo 'export ALIBABA_CLOUD_ESS_API_VERSION=2022-02-22' >> ~/.bashrc
source ~/.bashrc

プラグインの更新

指定したプラグインを更新できます：

aliyun plugin update --name ecs

インストール済みのプラグインをすべて更新できます。

aliyun plugin update

プラグインのアンインストール

aliyun plugin uninstall --name ecs

有効化の方法

この機能は、次のコマンドを実行して有効にできます：

aliyun configure set --auto-plugin-install true

または、環境変数を設定して有効にします (Linux の例)：

# 環境変数を追加して適用する
echo 'export ALIBABA_CLOUD_CLI_PLUGIN_AUTO_INSTALL=true' >> ~/.bashrc
source ~/.bashrc

設定後、aliyun configure get を実行して設定を確認できます。

プレリリースバージョンの自動インストールを有効にするには：

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

または、環境変数を使用して設定します。たとえば、Linux の場合：

# 環境変数を追加して適用する
echo 'export ALIBABA_CLOUD_CLI_PLUGIN_AUTO_INSTALL_ENABLE_PRE=true' >> ~/.bashrc
source ~/.bashrc

インストール戦略

コマンドラインインターフェイス (CLI) は、実行環境に基づいてポリシーを選択します。

以下は自動インストールのサンプル出力です：

# ecs プラグインがインストールされていない状態で実行
aliyun ecs describe-regions --accept-language zh-CN
# 自動インストールの出力
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!
......

インタラクティブインストールのサンプル出力 (自動インストールが無効の場合)：

# ecs プラグインがインストールされていない状態で実行
aliyun ecs describe-regions --accept-language zh-CN
# インタラクティブインストールの出力
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!
......

プラグインコマンドリファレンス

プラグイン環境変数

次の環境変数を使用して、プラグインの動作を制御できます：

プラグインのインストール時に「利用可能な安定版がありません」と表示される

このメッセージは、プラグインにプレリリースバージョンしか利用できないことを示します。プレリリースバージョンをインストールするには、インストールコマンドに --enable-pre パラメーターを追加します：

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