acloud リファレンス
acloud の共通の option、設定、終了コードと、コマンドの探し方です。導入とログインは はじめに にあります。
コマンドを調べる
すべてのコマンドの一覧は acloud --help で表示します。コマンドの候補と使い方は JSON でも調べられます。この 2 つはログインも通信も必要としません。
acloud --help
acloud cli search "WordPressサイトを作成"
acloud cli describe "server applications create"
AI のエージェントから操作する場合も、まず cli search で候補を取り、cli describe で引数と条件を確かめてから実行します。
設定
acloud config set project PROJECT_ID
acloud config get project
acloud config unset project
接続先の Platform API は既定で https://api.cloud.arcm.co.jp です。通常は変更しません。
共通の option
| option | 意味 |
|---|---|
--project PROJECT_ID | このコマンドだけ、設定とは別の Project を対象にする |
--format table|json | json は API の応答をそのまま出力する |
--platform-api-url URL | このコマンドだけ、接続先の Platform API を変える |
終了コード
| コード | 意味 |
|---|---|
0 | 成功 |
1 | その他の失敗 |
2 | 使い方の誤り |
3 | ログインしていない |
4 | 見つからない、または権限が無い |
5 | まだ利用できない |
応答が返らなかったとき
作成や変更の応答を受け取れなかった場合、結果は不明です。成功したとも失敗したとも扱わず、次のとおり確かめます。コマンドが次に実行するコマンドを表示した場合は、それに従います。
- 作成(
db create、server applications create、lb create)は、同じコマンドを再実行すると最初の要求の結果が返ります。 - 設定の変更(
db configuration update、db connection updateなど)は、先にdescribeで現在の値を確かめてから再実行します。 - 受け付けられた Operation は
acloud operations describe OPERATIONで状態を確かめます。
主なコマンド
| 対象 | コマンド | 手順 |
|---|---|---|
| ログイン | acloud auth login|logout|status | はじめに |
| Organization・Project | acloud organizations、acloud projects | Project と権限 |
| 製品と上限 | acloud services、acloud quotas | Project と権限 |
| 権限と招待 | acloud iam、acloud invitations | Project と権限 |
| WordPress | acloud server applications | WordPress Application |
| Database | acloud db | Database |
| Load Balancer | acloud lb | Load Balancer |
| Operation | acloud operations list|describe|retry | このページ |
| 版の確認 | acloud version --check | 新しい版があれば表示する |