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

プラグインの命名規則

プラグインは aliyun-cli-<ProductCode> という命名形式です。プロダクトコードは Alibaba Cloud OpenAPI と一致します。

完全名 (aliyun-cli-ecs) またはプロダクトコード (ecs) のいずれかを使用できます。名前は大文字と小文字を区別しません。

CLI サポートの確認

クラウド製品に CLI プラグインがあるかどうかを確認します。

• オンラインでの確認 (推奨)： CLI Center で、カテゴリ別に参照したり、キーワードで検索したり、コマンドの例を表示したりできます。

• コマンドラインでの確認： 使用可能なプラグインを一覧表示するか、キーワードで検索します。

  • リモートインデックス内のすべてのプラグインを一覧表示します。

    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          ECS の操作用 Alibaba Cloud CLI プラグイン。
    aliyun-cli-fc                            0.1.0           No       Installed      0.1.0          FC 3.0 の操作用 Alibaba Cloud CLI プラグイン。
    aliyun-cli-acc                           0.1.0           No       Not installed  -              acs の操作用 Alibaba Cloud CLI プラグイン。

プラグインの検索

特定のコマンドを提供するプラグインを検索します。プレフィックスマッチングがサポートされています。

# "ecs" を含むプラグインを検索します
aliyun plugin search ecs
# ecs プラグイン内で "describe" で始まるコマンドを検索します
aliyun plugin search "ecs describe"

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

aliyun plugin install は、--name (例: aliyun plugin install --name ecs) または位置引数 (例: aliyun plugin install ecs) でプラグインを指定します。どちらも同等です。--name は v3.3.14 で追加されました。

例：

# 名前で単一のプラグインをインストールします
aliyun plugin install --name ecs

# 特定のバージョンをインストールします
aliyun plugin install --name fc --version 1.0.0

# 複数のプラグインを一度にインストールします
aliyun plugin install --names ecs rds vpc

# ローカルアーカイブファイルからインストールします (オフライン環境用)
aliyun plugin install --package /path/to/ecs-plugin.zip

# URL からインストールします
aliyun plugin install --package https://example.com/plugins/ecs-plugin.tar.gz

aliyun plugin list で確認します。

Name                Version             Description
----                -------             -----------
aliyun-cli-ecs      0.1.0               Elastic Compute Service (ECS) の操作用 Alibaba Cloud CLI プラグイン。
aliyun-cli-fc       0.1.0               Function Compute (FC) 3.0 の操作用 Alibaba Cloud CLI プラグイン。

プラグインコマンドはケバブケースを使用します。CLI は、現在のプロファイルから認証情報 (AccessKey、STS Token)、リージョン、およびタイムアウトを自動的に引き継ぎます。--profile や --region などのグローバルオプションは、追加設定なしで適用されます。

コマンド形式：

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

使用例

aliyun ecs --help

aliyun ecs describe-regions --help

......
  --accept-language         string, 結果を言語でフィルタリングします。詳細については、[RFC
                            7231](https://tools.ietf.org/html/rfc7231) をご参照ください。有効な値：
                            - zh-CN: 簡体字中国語。
                            - zh-TW: 繁体字中国語。
                            - en-US: 英語。
                            - ja: 日本語。
                            - fr: フランス語。
                            - de: ドイツ語。
                            - ko: 韓国語。
                            デフォルト：en-US
  --instance-charge-type    string, インスタンスの課金方法。詳細については、https://help.aliyun.
                            com/document_detail/25398.html をご参照ください。有効な値：
                            - PrePaid: サブスクリプション。この方法を使用する場合、アカウントが残高支払いまたはクレジット支払いをサポートしていることを確認してください。
                            サポートしていない場合、`InvalidPayMethod` エラーが報告されます。
                            - PostPaid: 従量課金。
                            - SpotWithPriceLimit: ユーザーが定義したスポットインスタンスの最高価格。
                            - SpotAsPriceGo: システムが従量課金価格でスポットインスタンスを自動的に入札します。
                            デフォルト：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"
	},
......

高度な使用方法

Name                Version             Description
----                -------             -----------
aliyun-cli-ecs      0.1.0               ECS の操作用 Alibaba Cloud CLI プラグイン。
aliyun-cli-ess      0.1.0               複数バージョンの API をサポートする Auto Scaling の操作用 Alibaba Cloud CLI プラグイン。
aliyun-cli-fc       0.1.0               FC 3.0 の操作用 Alibaba Cloud CLI プラグイン。

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

プラグインの更新

特定のプラグインを更新します。

aliyun plugin update --name ecs

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

aliyun plugin update

すでに最新バージョンである場合、CLI は更新が不要であると表示します。プレリリースバージョンの場合は、--enable-pre を追加します。

aliyun plugin list で確認します。

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

プラグインを削除します。

aliyun plugin uninstall --name ecs

aliyun plugin list で削除を確認します。

自動インストールの有効化

コマンドで有効にします。

aliyun configure set --auto-plugin-install true

または、環境変数を使用します。

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

aliyun configure get で確認します。

プレリリースの自動インストールを許可します。

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

または、環境変数を使用します。

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

インストールポリシー

動作は、実行環境によって異なります。

自動インストールの出力例：

# ecs プラグインがインストールされていないときにコマンドを実行します
aliyun ecs describe-regions --accept-language en-US
# 自動インストールプロセスの出力
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 en-US
# インタラクティブインストールプロセスの出力
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!
......

現在の設定の表示

現在の設定を表示します。

aliyun configure plugin-settings show

カスタムプラグインソースの設定

カスタムソース URL を設定します。

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

確認します。

aliyun configure plugin-settings show

カスタム設定のクリア

カスタム設定をクリアして、デフォルト設定に戻します。

aliyun configure plugin-settings clear

ソース URL の優先順位

CLI は、次の場所を順番にチェックして、ソース URL を特定します (最初に一致したものが優先されます)。

1. 現在のコマンドの --source-base フラグ。

2. ALIBABA_CLOUD_CLI_PLUGIN_SOURCE_BASE 環境変数。

3. ~/.aliyun/plugin-settings.json 内の source-base 値。

4. 組み込みのデフォルト URL。

プラグインコマンド一覧

プラグインの環境変数

プラグインの動作に関する環境変数：

インストールに失敗：「no stable version available」

このプラグインにはプレリリースバージョンしかありません。--enable-pre を追加します。

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