CloudHub アプリケーションの CLI

コマンド 説明

環境内のすべてのアラートをリストする

アラームの履歴の情報を表示する

環境内のすべてのアプリケーションをリストする

アプリケーションの詳細を表示する

未加工のアプリケーション JSON 応答を表示する

実行中のアプリケーションを停止する

アプリケーションを開始する

実行中のアプリケーションを再起動する

アプリケーションを削除する

新しいアプリケーションをデプロイする

既存のアプリケーションを変更する (必要に応じて ZIP ファイルを更新する)

指定されたディレクトリにアプリケーションをダウンロードする

アプリケーションログの末尾を表示する

CloudHub アプリケーションをコピーする

runtime-mgr cloudhub-alert list

> runtime-mgr cloudhub-alert list [options]

このコマンドでは、現在の環境に関連付けられているすべてのアラートをリストします。

このコマンドはデフォルトのオプション ​--help​、​-f​/​--fields​、​-o​/​--output​ のみを受け入れます。

runtime-mgr cloudhub-alert-history describe

> runtime-mgr cloudhub-alert-history describe [options] <name>

このコマンドは、​<name>​ で渡されるアラームの履歴の情報を表示します。

このコマンドはデフォルトのオプション ​--help​、​-f​/​--fields​、​-o​/​--output​ のみを受け入れます。

runtime-mgr cloudhub-application list

> runtime-mgr cloudhub-application list [options]

このコマンドは、Anypoint Platform CLI で使用できるすべてのアプリケーションをリストします。アプリケーション、その状況、割り当てられている vCore の数、最終更新時間を返します。

このコマンドはデフォルトのオプション ​--help​、​-f​/​--fields​、​-o​/​--output​ のみを受け入れます。

runtime-mgr cloudhub-application describe

> runtime-mgr cloudhub-application describe [options] <name>

このコマンドは、​<name>​ で渡すアプリケーションに関する情報を表示します。
アプリケーションの名前の入力を開始して ​tab​ キーを押すと、Anypoint Platform CLI によって名前がオートコンプリートされます。また、​tab​ キーをダブルタップすると、渡すことができるすべての値の完全なリストが表示されます。
アプリケーションのドメイン、その状況、最終更新時間、Mule バージョン、ZIP ファイル名、リージョン、監視、ワーカー、および永続的なキューや静的 IP の有効化に関する ​TRUE​ または ​FALSE​ 情報などのデータを返します。

このコマンドはデフォルトのオプション ​--help​、​-f​/​--fields​、​-o​/​--output​ のみを受け入れます。

runtime-mgr cloudhub-application describe-json

> runtime-mgr cloudhub-application describe-json  [options] <name>

このコマンドは、​<name>​ で指定するアプリケーションの未加工の JSON 応答を返します。

アプリケーションの名前の入力を開始して ​tab​ キーを押すと、Anypoint Platform CLI によって名前がオートコンプリートされます。また、​tab​ キーをダブルタップすると、渡すことができるすべての値の完全なリストが表示されます。

このコマンドはデフォルトのオプション ​--help​、​-f​/​--fields​、​-o​/​--output​ のみを受け入れます。

runtime-mgr cloudhub-application stop

> runtime-mgr cloudhub-application stop  [options] <name>

このコマンドは、​<name>​ で指定する実行中のアプリケーションを停止します。
アプリケーションの名前の入力を開始して ​tab​ キーを押すと、Anypoint Platform CLI によって名前がオートコンプリートされます。また、​tab​ キーをダブルタップすると、渡すことができるすべての値の完全なリストが表示されます。

このコマンドはデフォルトのオプション ​--help​、​-f​/​--fields​、​-o​/​--output​ のみを受け入れます。

runtime-mgr cloudhub-application start

> runtime-mgr cloudhub-application start [options] <name>

このコマンドは、​<name>​ で指定する実行中のアプリケーションを開始します。
アプリケーションの名前の入力を開始して ​tab​ キーを押すと、Anypoint Platform CLI によって名前がオートコンプリートされます。また、​tab​ キーをダブルタップすると、渡すことができるすべての値の完全なリストが表示されます。

このコマンドはデフォルトのオプション ​--help​、​-f​/​--fields​、​-o​/​--output​ のみを受け入れます。

runtime-mgr cloudhub-application restart

> runtime-mgr cloudhub-application restart  [options] <name>

このコマンドは、​<name>​ で指定する実行中のアプリケーションを再起動します。
アプリケーションの名前の入力を開始して ​tab​ キーを押すと、Anypoint Platform CLI によって名前がオートコンプリートされます。また、​tab​ キーをダブルタップすると、渡すことができるすべての値の完全なリストが表示されます。

このコマンドはデフォルトのオプション ​--help​、​-f​/​--fields​、​-o​/​--output​ のみを受け入れます。

runtime-mgr cloudhub-application delete

> runtime-mgr cloudhub-application delete [options] <name>

このコマンドは、​<name>​ で指定する実行中のアプリケーションを削除します。

このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。

このコマンドはデフォルトのオプション ​--help​、​-f​/​--fields​、​-o​/​--output​ のみを受け入れます。

runtime-mgr cloudhub-application deploy

> runtime-mgr cloudhub-application deploy  [options] <name> <zipfile>

このコマンドは、​<name>​ で設定する名前を使用して、​<zipfile>​ で指定する Mule のデプロイ可能なアーカイブ ZIP ファイルをデプロイします。
アプリケーションの名前の入力を開始して ​tab​ キーを押すと、Anypoint Platform CLI によって名前がオートコンプリートされます。また、​tab​ キーをダブルタップすると、渡すことができるすべての値の完全なリストが表示されます。
ローカルハードドライブのデプロイ可能な ZIP ファイルの絶対パスまたは相対パスを指定する必要があります。また、アプリケーションには一意の名前を付ける必要があります。

成功すると、このコマンドの出力に ​UNDEPLOYED​ のデプロイメントの状況が含まれます。これは、CloudHub でアプリケーションが正常にアップロードされたことを示します。

このコマンドで使用できるオプションは、次のとおりです。

オプション 説明

--runtime

ランタイム環境の名前とバージョン。
このオプションを使用して、デプロイするランタイムの名前とバージョンを指定します。
この値の例として、​2.1.1-API-Gateway​、​3.9.1-visualizer​、​4.1.1​ などが挙げられます。
CLI で使用可能なすべてのオプションを表示するには、このオプションの後で ​tab​ キーをタップします。 (この値は、デフォルトでは最新の CloudHub Runtime バージョンとなります。)

--workers

ワーカーの数。(このデフォルト値は「1」)。

--workerSize

vCore のワーカーのサイズ。(このデフォルト値は「1」)。

--region

デプロイ先のリージョンの名前。
サポートされているすべてのリージョンのリストを取得するには、​cloudhub region list​ コマンドを使用します。

--property

プロパティ (​name:value​) を設定する。複数回指定できます。
設定するプロパティは引用符で囲み、文字 ​:​ および ​=​ はエスケープする必要があります。
(例: --property "salesforce.password:qa\=34534"​)。

文字 ​:​ は、プロパティの名前に使用できません。

--propertiesFile

このファイルの値ですべてのプロパティを上書きする。ファイル形式は、1 行以上の ​name:value​ 形式です。ローカルハードドライブのプロパティファイルの絶対パスを設定します。

--persistentQueues

永続的なキューを有効または無効にする。​true​ または ​false​ の値を使用できます。(このデフォルト値は ​false​)。

--persistentQueuesEncrypted

永続的なキューの暗号化を有効または無効にする。​true​ または ​false​ の値を使用できます。(このデフォルト値は ​false​)。

--staticIPsEnabled

静的 IP を有効または無効にする。​true​ または ​false​ の値を使用できます。(このデフォルト値は ​false​)。

--objectStoreV1

Object Store V1 を有効または無効にする。​true​ または ​false​ の値を使用できます。
objectStoreV1​ を使用する場合、​objectStoreV2​ も指定することはできません。

--objectStoreV2

Object Store V2 を有効または無効にする。​true​ または ​false​ の値を使用できます。
objectStoreV2​ を使用する場合、​objectStoreV1​ も指定することはできません。

--autoRestart

応答しない場合にアプリケーションを自動的に再起動する。​true​ または ​false​ の値を使用できます。(このデフォルト値は ​true​ です。)

--help

使用量情報を出力する

--timeout

タイムアウト値をミリ秒単位で設定します。​60000​ ~ ​300000​ の値を設定できます。

Anypoint Platform CLI から静的 IP を割り当てることはできません。有効化または無効化のみが可能です。

オプションの入力後、​tab​ キーをダブルタップすると、使用可能なすべてのオプションのリストが表示されます。 次に例を示します。

> deploy <app name> --runtime [tab][tab]

選択できる使用可能なすべてのランタイムをリストします。

オプションを使用せずにデプロイする場合、アプリケーションはすべてのデフォルト値を使用してデプロイされます。

runtime-mgr cloudhub-application modify

> runtime-mgr cloudhub-application modify  [options] <name> [zipfile]

このコマンドは、既存のアプリケーションの設定を更新します。必要に応じて、新しい ZIP ファイルをアップロードして更新できます。
アプリケーションの名前の入力を開始して ​tab​ キーを押すと、Anypoint Platform CLI によって名前がオートコンプリートされます。また、​tab​ キーをダブルタップすると、渡すことができるすべての値の完全なリストが表示されます。 このコマンドでは、​deploy​ オプションとまったく同じオプションを使用できます。

このコマンドの出力には、​Status​ (アプリケーションの以前のデプロイメントの状況の状態) が含まれます。

また、オプションの入力を開始して ​tab​ キーを押し、Anypoint Platform CLI でオプションをオートコンプリートすることもできます。

runtime-mgr cloudhub-application download-logs

> runtime-mgr cloudhub-application download-logs [options] <name> <directory>

このコマンドは、​<name>​ で指定されるアプリケーションのログを指定のディレクトリにダウンロードします。

アプリケーションの名前の入力を開始して ​tab​ キーを押すと、Anypoint Platform CLI によって名前がオートコンプリートされます。また、​tab​ キーをダブルタップすると、渡すことができるすべての値の完全なリストが表示されます。

UI とは異なり、CLI からダウンロードするログでは、システムログとワーカーログが分離されません。

runtime-mgr cloudhub-application tail-logs

> runtime-mgr cloudhub-application tail-logs [options] <name>

このコマンドは、アプリケーションログの末尾を表示します。
アプリケーションの名前の入力を開始して ​tab​ キーを押すと、Anypoint Platform CLI によって名前がオートコンプリートされます。また、​tab​ キーをダブルタップすると、渡すことができるすべての値の完全なリストが表示されます。

このコマンドはデフォルトのオプション ​--help​、​-f​/​--fields​、​-o​/​--output​ のみを受け入れます。

runtime-mgr cloudhub-application copy

> runtime-mgr cloudhub-application copy [options] <source> <target>

このコマンドは、​source​ で渡される CloudHub アプリケーションを ​target​ で渡される対象にコピーします。

引数 ​source​ および ​target​ は、​([group_id]/)<asset_id>/<version>​ の形式にする必要があります。

group_id​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。

次に例を示します。

> runtime-mgr cloudhub-application copy Services:QA/application-1 Development:QA/application-2

application-1​ という名前のアプリケーションをサービス組織の QA 環境から開発組織の QA 環境にコピーします。
Anypoint Platform CLI でサービス組織の QA 環境を使用する場合、コマンドの ​source​ としてアプリケーション名を使用できます。

> runtime-mgr cloudhub-application copy application-1 Development/QA/application-2
このコマンドを実行するには、ユーザーに OS の ​/tmp​ ディレクトリ (CLI のインストール先) への参照/更新アクセス権が必要です。

このコマンドでは、デフォルトの ​--help​、​-f​/​--fields​、​-o​/​--output​ オプション以外に次のオプションも使用できます。

オプション 説明

--property

プロパティ (​name:value​) を設定する。複数回指定できます。

プロパティは引用符で囲み、​:​ 文字と ​=​ 文字はエスケープします。例:

--property "salesforce.password:qa\=34534"

安全な隠しアプリケーションプロパティが含まれるアプリケーションをコピーする場合は、​--property​ オプションを使用して ​copy​ コマンドのプロパティを渡します。 安全な隠しアプリケーションプロパティについては、​「アプリケーションプロパティを安全に隠す」​を参照してください。