Alibaba Cloud CLI について
Alibaba Cloud CLI は Alibaba Cloud 公式のコマンドラインツールで、Alibaba Cloud OpenAPI への完全なアクセスを提供します。複数の設定プロファイル、SSO 認証、リクエスト診断に対応しており、自動化とスクリプト処理に適しています。
主な機能
- 01OpenAPI 経由でアリババクラウドのすべてのサービス(コンピュート、ストレージ、ネットワーク等)にアクセスする
- 02設定プロファイルを使用して複数のアカウントと認証情報を管理する
- 03リクエスト失敗を診断し API レスポンスの詳細を確認する
- 04JSON およびテーブル形式の構造化出力に対応
活用シーン
- 01コーディングエージェントでアリババクラウドのインフラストラクチャをデプロイして管理する
- 02スクリプト内で ECS インスタンスや OSS バケットなどのリソースをバッチ操作する
- 03CI/CD ワークフローにアリババクラウドサービス呼び出しを統合する
インストール
OS またはパッケージマネージャーを選び、コマンドをターミナルで実行します。
インストール後にaliyun --versionを実行して確認します。
コマンド例
よく使うコマンドを使う順に並べています。
詳細
Alibaba Cloud CLI
OpenAPI を通じて Alibaba Cloud のリソースを管理する、クロスプラットフォーム対応のコマンドラインツールです。
Alibaba Cloud CLI(aliyun)は Go で記述されており、macOS、Linux、Windows で動作します。対話型および非対話型の認証情報プロファイル、OpenAPI 呼び出し、ローカル API ヘルプ、構造化出力、待機機能、安全制御、拡張可能なプラグインシステムをサポートしています。
Alibaba Cloud CLI は OpenAPI を通じてクラウドサービスを呼び出します。対象のサービスをあらかじめ有効化し、使用する ID に必要な権限があることを確認してください。一時的な認証情報や ID ベースの認証方式が利用できる場合は、長期間有効な AccessKey の使用を避けてください。
インストール
次のいずれかの方法を選択してください。
# Homebrew
brew install aliyun-cli
# macOS or Linux installer script
/bin/bash -c "$(curl -fsSL https://aliyuncli.alicdn.com/install.sh)"
公式パッケージ:
インストールを確認します。
aliyun version
既存のスタンドアロンインストールをアップグレードします。
aliyun upgrade
CLI をパッケージマネージャー経由でインストールした場合は、そのパッケージマネージャーのアップグレードコマンドを使用してください。
PATH の設定、ソースからのビルド、アップグレードについては、インストールガイドを参照してください。
ローカルにインストールせずに CLI を試すには、Alibaba Cloud Shellを開いてください。
クイックスタート
1. プロファイルを設定する
対話型のローカル環境では、OAuth を使うことで、長期間有効な AccessKey を保存せずに済みます。
aliyun configure --mode OAuth --profile default
ブラウザーを利用できないリモートマシンでは、次のコマンドを使用します。
aliyun configure --mode OAuth --profile default --no-browser
表示された認証リンクを、ブラウザーを使えるデバイスで開きます。サインイン後、アドレスバーからコールバック URL 全体をコピーして CLI に貼り付けてください。ブラウザーに接続エラーが表示されても、URL を貼り付けます。code と state の両方を含めてください。この方式では、ローカルのコールバックサーバーは起動せず、ポートフォワーディングも必要ありません。キャンセルするには Ctrl+C を押してください。
必要に応じて、AK、StsToken、RamRoleArn、EcsRamRole、OIDC、External、CredentialsURI、ChainableRamRoleArn、CloudSSO、BearerToken、Anonymous モードも使用できます。
# Inspect and select profiles
aliyun configure list
aliyun configure switch --profile default
本番環境や CI でプロファイルを使用する前に、設定と認証情報を参照してください。
2. API を呼び出す
メタデータが利用できる場合は、従来の PascalCase 形式とメタデータ駆動の kebab-case 形式の両方を使用できます。
aliyun ecs DescribeRegions
aliyun ecs describe-regions
安全ポリシーでは、API エイリアスを展開せずに、コマンド名を大文字と小文字を区別せず照合します。自動化で使用するコマンド名ごとにルールを設定してください。コマンドの照合ルールを参照してください。
3. ヘルプを確認する
aliyun --help
aliyun ecs DescribeInstances --help
aliyun ecs describe-instances --help
主な機能
出力をフィルタリングして整形する
aliyun ecs DescribeInstances \
--output cols=InstanceId,Status rows=Instances.Instance[]
aliyun ecs describe-instances \
--cli-query 'Instances.Instance[].{Id:InstanceId,Status:Status}'
リソースの状態を待つ
aliyun ecs DescribeInstances \
--InstanceIds '["i-example"]' \
--waiter expr='Instances.Instance[0].Status' to=Running
製品プラグインを使用する
aliyun plugin search <command-name>
aliyun plugin install --name <plugin-name>
aliyun plugin list
aliyun plugin update --name <plugin-name>
一連の操作について詳しくは、コマンドの使い方とプラグイン管理を参照してください。
トラブルシューティング
OpenAPI トラブルシューティングでは、RequestIdまたはエラーメッセージを使って、OpenAPI リクエストの失敗原因を調査できます。
ドキュメント
| トピック | 英語 | 简体中文 |
|---|---|---|
| ドキュメントの目次 | 英語 | 中文 |
| インストールとアップグレード | ガイド | 指南 |
| 設定と認証情報 | ガイド | 指南 |
| コマンド、出力、自動化 | ガイド | 指南 |
| MCP、OpenTelemetry、マシンインターフェース | ガイド | 指南 |
| 組み込み OSS 自動化 | ガイド | 指南 |
| プラグイン管理 | ガイド | 指南 |
その他のリソース:
サポート
- 既存の情報を検索するか、GitHub イシューを作成してください。
- セキュリティ上の脆弱性が疑われる場合は、公開イシューを作成せず、SECURITY.mdの手順に従ってください。
- リリースノートとバイナリはリリースページで入手できます。
ライセンス
Alibaba Cloud CLI はApache License 2.0のライセンスに基づいています。