Anypoint Platform CLI 3.x のコマンドリスト

logo cloud active logo hybrid active logo server active logo rtf active

Anypoint Platform CLI には、さまざまなユースケースシナリオに対応するコマンドが用意されています。

Anypoint Platform CLI には、3 つのデフォルトオプションがあります。

  • --help​ オプション。コマンドの利用方法の情報を表示します。

  • -o​ または ​--output​ オプション。コマンドの出力を定義済みの形式に指定できます。
    サポートされている値は、​table​、​text​、​json​ です。非対話型モードのデフォルトは ​text​、対話型セッションのデフォルトは ​table​ です。

  • -f​ または ​--fields​ オプション。出力する項目を定義できます。
    コマンドの後に ​--fields​ オプションを渡して、出力可能なすべての項目のリストを取得できます。

Anypoint Platform アカウントを管理するコマンド

コマンド 説明

アカウントの詳細を表示する

ビジネスグループをリストする

ビジネスグループの詳細を表示する

環境をリストする

新しい環境を作成する

環境を削除する

環境の詳細を表示する

API Manager のコマンド

コマンド 説明

API インスタンスアラートを作成する

API インスタンスのアラートをリストする

Exchange の新しいバージョンを選択して、API インスタンスのアセットバージョンを変更する

特定の環境の API インスタンスを分類する

API を削除する

CloudHub、ハイブリッドサーバ、Runtime Fabric に API をデプロイする

API インスタンスを非推奨にする

API の詳細を表示する

ローカルディレクトリに API プロキシ ZIP ファイルをダウンロードする

API インスタンスを編集する

API Manager 2.x のすべての API をリストする

Exchange のアセットを使用して、新しい API、API バージョン、新しい API インスタンスを管理する

昇格元環境の API インスタンスを昇格する

CloudHub、ハイブリッドサーバ、Runtime Fabric に API を再デプロイする

API インスタンスの非推奨を解除する

特定の API コントラクトを削除する

特定の API インスタンスに対するすべてのコントラクトをリストする。

特定の API インスタンスにポリシーを適用する

特定のポリシーテンプレートの情報と使用可能な設定プロパティを表示する

特定の API インスタンスのポリシーを無効にする

特定の API インスタンスのポリシー設定を編集する

特定の API インスタンスのポリシーを有効にする

ポリシーをリストする

特定の API インスタンスからポリシーを削除する

SLA 層を作成する

コピー元から対象 API インスタンスに SLA 層をコピーする

API インスタンスから SLA 層を削除する

API インスタンスの SLA 層をリストする

Anypoint DataGraph を管理するコマンド

コマンド 説明

専用ロードバランサ設定を Anypoint DataGraph に追加する

Anypoint DataGraph の専用ロードバランサ設定を表示する

専用ロードバランサ設定を Anypoint DataGraph から削除する

Design Center アプリケーションを管理するコマンド

コマンド 説明

新しい Design Center プロジェクトを作成する

Design Center プロジェクトを削除する

Design Center プロジェクトのコンテンツをダウンロードする

Design Center プロジェクトを Exchange にパブリッシュする

プロジェクトのコンテンツを Design Center にアップロードする

すべての Design Center プロジェクトをリストする

Exchange アセットを管理するコマンド

コマンド 説明

Exchange アセットをアップロードする

Exchange Experience API v2 を使用して Exchange アセットをアップロードする

Exchange アセットを変更する

Exchange アセットをダウンロードする

すべてのアセットをリストする

Exchange のアセットの説明ページをダウンロードする

Exchange のアセットの説明ページを変更する

Exchange のアセットの説明ページをアップロードする

Exchange のアセットの説明ページを削除する

特定のアセットのすべてのページをリストする

Exchange アセットをコピーする

Exchange のアセットを削除する

アセットを非推奨にする

アセットの非推奨を解除する

特定のアセットの情報を表示する

CloudHub アプリケーションを管理するコマンド

コマンド 説明

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Runtime Manager の管理下にある、ローカルにデプロイされているアプリケーションを管理するコマンド

Anypoint Platform CLI で対象サーバを認識できるように、手動で各サーバをプラットフォームに登録する必要があります。
コマンド 説明

スタンドアロンアプリケーションアーチファクトバイナリをダウンロードする

オンプレミスサーバ、サーバグループ、クラスタにアプリケーションをデプロイまたは再デプロイする

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

スタンドアロンアプリケーションアーチファクトを変更する

スタンドアロンアプリケーションを開始する

スタンドアロンアプリケーションを削除する

スタンドアロンアプリケーションの詳細情報を表示する

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

スタンドアロンアプリケーションを再起動する

スタンドアロンアプリケーションを停止する

スタンドアロンアプリケーションをコピーする

Runtime Fabric インスタンスをリストするコマンド

コマンド 説明

使用可能な Runtime Fabric インスタンスをリストする

ローカルサーバを管理するコマンド

コマンド 説明

サーバの情報を表示する

サーバを変更する

サーバ登録トークンを取得する。新しいサーバを登録するには、このトークンを使用する必要があります。

サーバを削除する

スタンドアロンアプリケーションアーチファクトを変更する

ローカルサーバグループを管理するコマンド

コマンド 説明

サーバのサーバグループを作成する

サーバグループの情報を表示する

サーバグループを変更する

サーバをサーバグループに追加する

サーバグループを削除する

環境内のすべてのサーバグループをリストする

サーバグループのサーバを削除する

ローカルクラスタサーバを管理するコマンド

コマンド 説明

サーバをクラスタに追加する

クラスタを削除する

環境内のすべてのクラスタをリストする

クラスタからサーバを削除する

新しいクラスタを作成する

サーバクラスタの情報を表示する

クラスタを変更する

Runtime Manager の管理下にある、ローカルにデプロイされているアプリケーションのアラートを管理するコマンド

コマンド 説明

アラートの情報を表示する

スタンドアロンランタイムの新しいアラートを作成する

スタンドアロンランタイムのアラートを変更する

環境内のスタンドアロンランタイムのすべてのアラートをリストする

CloudHub 専用ロードバランサを管理するコマンド

コマンド 説明

組織内のすべてのロードバランサをリストする

ロードバランサの詳細を表示する

未加工の JSON 応答でロードバランサの詳細を表示する

ロードバランサを作成する

ロードバランサを開始する

ロードバランサを停止する

ロードバランサを削除する

証明書を既存のロードバランサに追加する

ロードバランサから証明書を削除する

ロードバランサが提供するデフォルトの証明書を設定する

特定の証明書のロードバランサ設定を表示する

IP または IP の範囲をロードバランサの許可リストに追加する

IP または IP の範囲をロードバランサの許可リストから削除する

ロードバランサのプロキシマッピングルールをリストする。​certificateName​ が指定されていない場合、デフォルトの SSL エンドポイントのマッピングが表示されます。

指定されたインデックスでプロキシマッピングルールを追加する。​certificateName​ が指定されていない場合、デフォルトの SSL エンドポイントのマッピングが表示されます。

プロキシマッピングルールを削除します。​certificateName​ が指定されていない場合、デフォルトの SSL エンドポイントのマッピングが表示されます。

動的 IP を有効にする

動的 IP を無効にする

サポートされているすべてのリージョンをリストする

使用可能なすべてのランタイムをリストする

CloudHub Anypoint VPC を管理するコマンド

コマンド 説明

すべての Anypoint VPC をリストする

Anypoint VPC の詳細を表示する

未加工の Anypoint VPC JSON 応答を表示する

新しい Anypoint VPC を作成する

既存の Anypoint VPC を削除する

Runtime Manager 環境と Anypoint VPC の関連付けを変更する。

Runtime Manager 環境と Anypoint VPC の関連付けを変更する。

Anypoint VPC を一連のビジネスグループと共有する。

Anypoint VPC を一連のビジネスグループと共有する。

内部 DNS サーバを使用して解決されるドメイン名を設定する。オプションを指定せずに使用する場合、内部 DNS が無効になります。

内部 DNS サーバを使用して解決されるドメイン名のリストをクリアする

この Anypoint VPC の Mule アプリケーションのファイアウォールルールを表示する

この Anypoint VPC の Mule アプリケーションのファイアウォールルールを追加する

この Anypoint VPC の Mule アプリケーションのファイアウォールルールを削除する

環境およびビジネスグループを指定するコマンド

コマンド 説明

指定された環境をアクティブにする

指定されたビジネスグループをアクティブにする

Anypoint Platform CLI コールの形式は、次のようになります。

$ anypoint-cli [params] [command]

コマンドを渡さない場合、Anypoint Platform CLI は対話型モードで実行されます。 特定のコマンドを渡してエラーがあると、アプリケーションが終了して問題の説明が返されます。

account user describe

> account user describe  [options]

このコマンドは、アカウントの情報を返します。これには、ユーザ名、氏名、メールアドレス、アカウントの作成日が含まれます。
このコマンドでは、デフォルトのオプション (​--help​、​-f​/​--fields​、​-o​/​--output​) 以外のオプションは使用できません。

account business-group list

> account business-group list [options]

このコマンドは、すべての​ビジネスグループ​をリストします。ビジネスグループの名前、種別 (「Master」または「Business unit」)、ID を返します。

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

account business-group describe

> account business-group describe  [options] <name>

このコマンドは、​<name>​ で渡すビジネスグループに関する情報を表示します。
<name>​ が指定されていない場合、このコマンドは現在のセッションのビジネスグループの情報を表示します。

ビジネスグループまたは組織名にスペースが含まれている場合、その名前を ​"​ 文字で囲む必要があります。

> account business-group describe "QA Organization"

このコマンドは、オーナー、種別、サブスクリプション情報、グループのエンタイトルメント、実行環境などのデータを返します。

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

account environment list

> account environment list [options]

このコマンドは、Anypoint Platform のすべての環境をリストします。環境名、ID、および Sandbox 環境かどうかどうかを返します。
このコマンドでは、デフォルトのオプション (​--help​、​-f​/​--fields​、​-o​/​--output​) 以外のオプションは使用できません。

account environment create

> account environment create [options] <name>

このコマンドは、​<name>​ で設定した名前を使用して新しい環境を作成します。
このコマンドでは、デフォルトの ​--help​、​-f​/​--fields​、​-o​/​--output​ オプション以外に ​--type​ オプションも使用できます。​--type​ オプションを使用して、環境種別を指定します。
環境種別では、次の値がサポートされています。

  • design

  • production

  • sandbox

種別が指定されていない場合、このコマンドは本番環境を作成します。

account environment delete

> account environment delete  [options] <name>

このコマンドは、​<name>​ で指定される環境を削除します。

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

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

account environment describe

> account environment describe [options] <name>

このコマンドは、​<name>​ で指定される環境に関する情報を返します。
<name>​ が指定されていない場合、このコマンドは現在のセッションの環境に関する情報を返します。

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

api-mgr alert add

> api-mgr alert add [options] <apiInstanceId> <name>

このコマンドは、​<apiInstanceId>​ で渡される API インスタンス ID の ​name​ で渡される名前を使用して、API インスタンスアラートを作成します。

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

説明

enabled

アラートを有効にするかどうかを設定する。
使用可能な値は ​true​ または ​false​ です。

severity <val>

アラートの重要度。
サポートされている値: Info​、​Warning​、​Critical​。

type <val>

アラートタイプ/条件。
サポートされている値: request-count​、​response-code​、​policy-violation​、​response-time

operator <val>

しきい値に関する値を記述する条件演算子。
サポートされている値: gt、lt、eq

threshold <num>

条件が発生するしきい値。

periods <num>

条件が発生する連続期間数。

duration <num>

条件が発生する期間。

durationUnit <val>

条件が発生する期間の単位。
サポートされている値: days、hours、minutes。

recipient [username]

アラート通知を送信するユーザ名。
このオプションを複数回渡して、複数のユーザ名を指定できます。

email [emailAddress]

アラート通知を送信するメール。
このオプションを複数回渡して、複数のメールを指定できます。

responseTime [num]

response-time​ アラートタイプをトリガする応答時間。

responseCode [code]

response-code​ アラートタイプをトリガする応答コード。
このオプションを複数回渡して、複数のコードを指定できます。

policyId [num]

response-code​ アラートタイプをトリガする API インスタンスに適用されるポリシーの ID。

api-mgr alert list

> api-mgr alert list [options] <apiInstanceId>

<apiInstanceId>​ で渡される API インスタンスのアラートをリストする。

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

説明

--offset

渡された API の数をオフセットする

api-mgr alert list --offset 3

--sort

渡された項目名の結果を並び替える

api-mgr alert list --sort "Latest Version"

api-mgr api change-specification

> api-mgr api change-specification [options] <apiInstanceId> <assetVersion>

<assetVersion>​ で渡される Exchange の新しいバージョンを選択して、​<apiInstanceId​ で渡される API インスタンスのアセットバージョンを変更します。

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

api-mgr api classify

> api-mgr api classify [options] <destEnvName> <apiInstanceId>

<destEnvName>​ で渡される環境の ​<apiInstanceId>​ で渡される API インスタンスを分類します。

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

api-mgr api delete

> api-mgr api delete [options] <apiInstanceId>

このコマンドは、​<apiInstanceId>​ で渡される API インスタンスを削除します。

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

api-mgr api deploy

> api-mgr api deploy [options] <apiInstanceId>

このコマンドは、<apiInstanceId> で渡される API インスタンスを下記のオプションを使用して指定されるデプロイメント対象にデプロイします。

このコマンドは、プロキシを持つエンドポイントでのみサポートされています。

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

説明

target <id>

ハイブリッドまたは RTF デプロイメント対象 ID。

api-mgr api deploy --target 1598794 643404

applicationName <name>

アプリケーション名

api-mgr api deploy --applicationName myMuleApp 643404

environmentName <name>

対象環境名。未分類の環境から API をデプロイする場合にのみ使用する必要があります。

api-mgr api deploy --environmentName TestEnv 643404

gatewayVersion <version>

CloudHub ゲートウェイのバージョン

api-mgr api deploy --gatewayVersion: 9.9.9.9 643404

overwrite

アプリケーションを更新する (存在する場合)。
true​ または ​false​ の値を使用できます。

api-mgr api deploy --overwrite: true 643404

api-mgr api deprecate

> api-mgr api deprecate [options] <apiInstanceId>

<apiInstanceId>​ で渡される API インスタンスを非推奨にします。

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

api-mgr api describe

> api-mgr api describe [options] <apiInstanceId>

<apiInstanceId>​ で渡される API インスタンスの詳細を表示します。

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

api-mgr api download-proxy

> api-mgr api download-proxy [options] <apiInstanceId> <targetPath>

このコマンドは、​<apiInstanceId>​ で渡される API インスタンスの API プロキシ ZIP ファイルを ​<targetPath>​ で指定されるローカルディレクトリにダウンロードします。

このコマンドでは、デフォルトの ​--help​、​-f​/​--fields​、​-o​/​--output​ オプション以外に ​gatewayVersion​ オプションを使用して、ダウンロードするゲートウェイのバージョンを指定することもできます。 例: api-mgr api download-proxy --gatewayVersion: 4.0.1 643404 /tmp/

api-mgr api edit

> api-mgr api edit [options] <apiInstanceId>

<apiInstanceId>​ で渡される API インスタンスを編集します。
このコマンドでは、デフォルトの ​--help​、​-f​/​--fields​、​-o​/​--output​ オプション以外に次のオプションも使用できます。

説明

-p, --withProxy

エンドポイントでプロキシを使用するかどうかを示す。
このオプションでは、​true​ または ​false​ の値を使用できます。

-r, --referencesUserDomain

プロキシでユーザドメインを参照する必要があるかどうかを示す。
このオプションでは、​true​ または ​false​ の値を使用できます。

-m, --muleVersion4OrAbove

Mule 4 以上でこの API を管理するかどうかを示す。
このオプションでは、​true​ または ​false​ の値を使用できます。

--deploymentType <value>

デプロイメント種別。
サポートされている値は、​cloudhub​、​hybrid​、​rtf​ です。

--uri <value>

実装 URI。

--scheme <value>

プロキシスキーム。
サポートされている値は、​http​ または ​https​ です。

--port <value>

プロキシポート。

--path <value>

プロキシパス。

--responseTimeout <value>

最大応答タイムアウト。

--apiInstanceLabel <value>

(省略可能) API インスタンスの表示ラベル。

--serviceName <value>

WSDL サービス名。

--serviceNamespace <value>

WSDL サービス名前空間。

--servicePort <value>

WSDL サービスポート。

api-mgr api list

> api-mgr api list [options]

API Manager 2.x のすべての API をリストします。

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

説明

--assetId <value>

結果を絞り込むアセット ID。

--apiVersion <value>

結果を絞り込む API バージョン。

--instanceLabel <value>

結果を絞り込む API インスタンスの表示ラベル。

--limit <num>

取得する結果の数。

--offset

渡された API の数をオフセットする

--sort

渡された項目名の結果を並び替える

api-mgr api manage

> api-mgr api manage [options] <assetId> <assetVersion>

<assetId>​ で渡される Exchange アセット (​<assetVersion>​ で渡されるバージョン) を使用して、新しい API、API バージョン、新しい API インスタンスを管理します。

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

説明

--type <value>

エンドポイント種別。
使用可能な値は、​http​、​raml​、​wsdl​ です。

-p, --withProxy

エンドポイントでプロキシを使用するかどうかを示す。
このオプションでは、​true​ または ​false​ の値を使用できます。

-r, --referencesUserDomain

プロキシでユーザドメインを参照する必要があるかどうかを示す。
このオプションでは、​true​ または ​false​ の値を使用できます。

-m, --muleVersion4OrAbove

Mule 4 以上でこの API を管理するかどうかを示す。
このオプションでは、​true​ または ​false​ の値を使用できます。

--deploymentType <value>

デプロイメント種別。
サポートされている値は、​cloudhub​、​hybrid​、​rtf​ です。

--uri <value>

実装 URI。

--scheme <value>

プロキシスキーム。
サポートされている値は、​http​ または ​https​ です。

--port <value>

プロキシポート。

--path <value>

プロキシパス。

--responseTimeout <value>

応答タイムアウト。

--apiInstanceLabel <value>

(省略可能) API インスタンスの表示ラベル。

--serviceName <value>

WSDL サービス名。

--serviceNamespace <value>

WSDL サービス名前空間。

--servicePort <value>

WSDL サービスポート。

api-mgr api promote

> api-mgr api promote [options] <apiInstanceId> <sourceEnvId>

<sourceEnvId>​ で渡される昇格元環境の ​<apiInstanceId>​ で渡される API インスタンスを昇格します。

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

説明

-a, --copyAlerts

アラートをコピーするかどうかを示す。
このオプションでは、​true​ または ​false​ の値を使用できます。デフォルト値は ​true​ です。

-p, --copyPolicies

ポリシーをコピーするかどうかを示す。
このオプションでは、​true​ または ​false​ の値を使用できます。デフォルト値は ​true​ です。

-t, --copyTiers

層をコピーするかどうかを示す。
このオプションでは、​true​ または ​false​ の値を使用できます。デフォルト値は ​true​ です。

api-mgr api redeploy

> api-mgr api redeploy [options] <apiInstanceId>

<apiInstanceId>​ で渡される API インスタンスを下記のオプションでセットアップされるデプロイメント対象に再デプロイします。

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

説明

--target <id>

ハイブリッドまたは RTF デプロイメント対象 ID。

--applicationName <name>

アプリケーション名。

--environmentName <name>

対象環境名。
未分類の環境から API を再デプロイする場合に指定する必要があります。

--gatewayVersion <version>

CloudHub ゲートウェイのバージョン。

--overwrite

アプリケーションを更新する (存在する場合)。
このオプションでは、​true​ または ​false​ の値を使用できます。デフォルト値は ​true​ です。

api-mgr api undeprecate

> api-mgr api undeprecate [options] <apiInstanceId>

<apiInstanceId>​ で渡される API インスタンスの非推奨を解除します。

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

api-mgr contract delete

> api-mgr contract delete [options] <apiInstanceId> <clientId>

このコマンドは、​<apiInstanceId>​ で渡される API インスタンスと ​<clientId>​ で渡されるクライアント間のコントラクトを削除します。

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

api-mgr contract list

> api-mgr contract list [options] <apiInstanceId> [searchText]

<apiInstanceId>​ で渡される API のすべてのコントラクトをリストします。

searchText でキーワードを指定して、それらの特定のキーワードが含まれる API のみが結果に表示されるように制限できます。

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

説明

--limit

取得する結果の数

exchange asset list --limit 2

--offset

渡された API の数をオフセットする

api-mgr contract list --offset 3 643404

--sort

渡された項目名の結果を並び替える

api-mgr contract list --sort "Latest Version" 643404

api-mgr policy apply

> api-mgr policy apply [options] <apiInstanceId> <policyId>

<policyId>​ で渡されるポリシーを ​<apiInstanceId>​ で渡される API インスタンスに適用します。

説明

--policyVersion <value>

Mule 4 ポリシーバージョン。

--groupId <value>

Mule 4 ポリシーグループ ID。
値が指定されていない場合、この値はデフォルトの MuleSoft グループ ID になります。

-c, --config [configJSON]

設定データを JSON 文字列として渡す。
(例: api-mgr policy apply -c '{"property": "value"}'​)。

-p, --pointcut [dataJSON]

ポイントカットデータを JSON 文字列として渡す。
例: `api-mgr policy apply (…​) -p '[{"methodRegex":"GET

api-mgr policy describe

> api-mgr policy describe [options] <policyId>

このコマンドは、​<policyId>​ で渡されるポリシーの情報と使用可能な設定プロパティを表示します。

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

説明

--policyVersion <value>

Mule4 ポリシーバージョン。

--groupId <value>

Mule4 ポリシーグループ ID。
指定されていない場合、デフォルトの MuleSoft グループ ID になります。

api-mgr policy disable

> api-mgr policy disable [options] <apiInstanceId> <policyId>

このコマンドは、​<apiInstanceId>​ で渡される API インスタンスの ​<policyId>​ で渡されるポリシーを無効にします。

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

api-mgr policy edit

> api-mgr policy edit [options] <apiInstanceId> <policyId>

このコマンドは、​<apiInstanceId>​ で渡される API インスタンスの ​<policyId>​ で渡されるポリシー設定を編集にします。

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

説明

-c, --config [configJSON​]

設定データを JSON 文字列として渡す。
(例: api-mgr policy apply -c '{"property": "value"}'​)。

-p, --pointcut [dataJSON]

ポイントカットデータを JSON 文字列として渡す。
例: `api-mgr policy apply (…​) -p '[{"methodRegex":"GET

api-mgr policy enable

> api-mgr policy enable [options] <apiInstanceId> <policyId>

このコマンドは、​<apiInstanceId>​ で渡される API インスタンスの ​<policyId>​ で渡されるポリシーを有効にします。

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

api-mgr policy list

> api-mgr policy list [options] [apiInstanceId]

このコマンドは、API Manager 2.x のすべての API の全ポリシーをリストします。
[apiInstanceId]​ パラメータが指定されると、このコマンドはその API インスタンスに適用されるポリシーをリストします。

このコマンドでは、デフォルトの ​--help​、​-f​/​--fields​、​-o​/​--output​ オプション以外に、​true​ または ​false​ 値を取る ​-m, --muleVersion4OrAbove​ オプションも使用できます。

api-mgr policy remove

> api-mgr policy remove [options] <apiInstanceId> <policyId>

このコマンドは、​<apiInstanceId>​ で渡される API インスタンスから ​<policyId>​ で指定されるポリシーを削除します。

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

api-mgr tier add

> api-mgr tier add [options] <apiInstanceId>

このコマンドは、​<apiInstanceId>​ で渡される API インスタンスの SLA 層を作成します。

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

説明

-a, --autoApprove

SLA 層を自動承認する必要があるかどうかを示す。
このコマンドでは、​true​ または ​false​ の値のみを使用できます。

--name <value>

層の名前

--description <value>

層の情報

-l, --limit <value>

-l, --limit

api-mgr tier copy

> api-mgr tier copy [options] <sourceAPIInstanceId> <targetAPIInstanceId>

このコマンドは、​<sourceAPIInstanceId>​ で渡される API インスタンスから ​<targetAPIInstanceId>​ で渡される API インスタンス ID に SLA 層をコピーします。

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

api-mgr tier delete

> api-mgr tier delete [options] <apiInstanceId> <tierId>

このコマンドは、​<apiInstanceId>​ で渡される API インスタンスから ​<tierId>​ で渡される SLA 層を削除します。

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

api-mgr tier list

> api-mgr tier list [options] <apiInstanceId> [searchText]

このコマンドは、​<apiInstanceId>​ で渡される API インスタンスの SLA 層をリストします。

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

説明

--limit

取得する結果の数

api-mgr tier list --limit 2

--offset

渡された API の数をオフセットする

api-mgr tier list --offset 3

--sort

渡された項目名の結果を並び替える

api-mgr tier list --sort "Latest Version"

datagraph load-balancer-config add

> datagraph load-balancer-config add <dlbUrl>

このコマンドでは、​<dlbUrl>​ で指定された専用ロードバランサ設定を Anypoint DataGraph に追加します。 dlbUrl​ は、DLB ドメインとマッピングルール ​inputUri​ を含む有効な URL です。

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

datagraph load-balancer-config describe

> datagraph load-balancer-config describe [options]

このコマンドでは、Anypoint DataGraph の専用ロードバランサの URL を表示します。

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

datagraph load-balancer-config remove

> datagraph load-balancer-config remove [options]

このコマンドでは、専用ロードバランサ設定を Anypoint DataGraph から削除します。

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

designcenter project create

> designcenter project create [options] <name>

このコマンドは、​<name>​ で指定される名前を使用して、新しい Design Center プロジェクトを作成します。

このコマンドでは、Mule アプリケーション種別はサポートされていません。

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

コマンド 説明

--type (required)

プロジェクトタイプ。
この項目は必須です。

サポートされている値は、次のとおりです。

  • raml

  • raml-fragment

designcenter project create --type raml

--fragment-type

アプリケーション種別が RAML フラグメントの場合のフラグメントタイプ。

type オプションが ​raml-fragment​ として設定されている場合、この項目は必須です。

サポートされているフラグメントタイプは、次のとおりです。

  • trait

  • resource-type

  • library

  • type

  • user-documentation

designcenter project create --type raml-fragment --fragment-type user-documentation

designcenter project delete

> designcenter project delete [options] <name>

このコマンドは、​name​ で指定される Design Center プロジェクトを削除します。

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

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

designcenter project download

> designcenter project download [options] <name> <targetDir>

このコマンドでは、​name​ で渡される Design Center プロジェクトを ​targetDir​ で指定されるローカルディレクトリにダウンロードします。

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

designcenter project publish

> designcenter project publish [options] <projectName>

このコマンドは、​projectName​ で渡される Design Center プロジェクトを Exchange をパブリッシュします。
このコマンドでは、デフォルトの ​--help​、​-f​/​--fields​、​-o​/​--output​ オプション以外に次のオプションも使用できます。

指定されていないオプションは、exchange.json から抽出されます。
コマンド 説明

--name

アセットの名前

designcenter project publish --name sampleProject

--main

メインファイル名の名前。

designcenter project publish --main sample.xml

--apiVersion

プロジェクトが API 仕様プロジェクトの場合の API バージョン。

designcenter project publish --main sample.raml --apiVersion 1.0

--tags

タグのカンマ区切りリスト。

designcenter project publish --tags test,sample,integration

--groupId

アセットのグループ ID。

designcenter project publish --groupId com.mulesoft.com

--assetId

アセットのアセット ID。

designcenter project publish --assetId project

--version

アセットのバージョン。

designcenter project publish --version 1.0

designcenter project upload

> designcenter project upload [options] <name> <projDir>

このコマンドは、​projDir​ で渡されるローカルディレクトリの Design Center プロジェクトをアップロードし、​name​ で渡される名前を使用して名前を付けます。

デフォルトでは、このコマンドは非表示のファイルおよびディレクトリをすべて無視します。非表示のファイルおよびディレクトリを含めるには、​--include-dot-files​ オプションを使用します。
--include-dot-files​ オプションを使用すると、コマンドは指定されたディレクトリの非表示のファイルおよびフォルダをアップロードします。

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

designcenter project list

> designcenter project list [options] [searchText]

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

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

コマンド 説明

--pageIndex

取得するページの数

designcenter project list --pageIndex 3

--pageSize

ページあたりの取得する結果の数

designcenter project list --pageSize 5

exchange asset upload

> exchange asset upload [options] <assetIdentifier> [filePath]

このコマンドは、​<assetIdentifier>​ で渡される ID を使用して、OAS、RAML、WSDL、HTTP、またはカスタムアセットをアップロードします。
<filePath>​ で ZIP アーカイブファイルが参照されている場合、アセットを記述する ​exchange.json​ ファイルがそのアーカイブに含まれている必要があります。
引数 ​assetIdentifier​ は、​<group_id>/<asset_id>/<version>​ の形式にする必要があります。

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

コマンド 説明

--apiVersion

アセット API バージョン

exchange asset upload --apiVersion 1.0 --name testProject --classifier custom

exchange asset upload --mainFile 'api.yml'

--name

アセット名

--mainFile

API アセットのメインファイル

--classifier

有効なアセット分類子は、​oas​、​raml​、​wsdl​、​http​、​custom​ です。

exchange asset uploadv2

> exchange asset uploadv2 [properties] <assetIdentifier>

このコマンドでは、<assetIdentifier> で渡される ID を使用して、rest-api、soap-api、http-api、raml-fragment、custom、app、template、example、policy、extension、external-library、または connector アセットをアップロードします。

assetIdentifier​ 引数には次の形式を使用します。

([groupID]/)assetID/version

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

コマンド 説明

--name

アセット名 (pom ファイルが指定されていない場合に必要)

exchange asset uploadv2 --name "Raml Asset" --description "RAML" --properties.apiVersion v1 --properties.mainFile api.raml --files.raml.zip /…​./file-path/raml.zip raml-asset/1.0.0

--description

アセットの説明

--properties

アセットプロパティ

次に例を示します。

  • properties.mainFile main.yaml

  • properties.apiVersion v1

  • properties.assetLink http://api.com

--files

アセットファイル (​classifier.packaging​ または ​packaging​ として識別される。例: files.raml.zip …​/file-path/raml.zip​)

複数のファイルを送信するには、同じオプションを複数回使用します。

--files.custom.zip custom.zip --files.pom.xml pom.xml

exchange asset uploadv2 --files.mule-application.jar /…​./file-path/mule-app.jar --files.pom /…​./file-path/mule-app.pom fa7b266c-3817-4cbb-ae49-7f3cc6c8cd9e/my-mule-app/1.0.0

--type

アセットタイプ

ファイルが指定されていない場合に必要です。

アップロードされると、タイプはファイルの分類子から推定されます。

サポートされる値:

  • rest-api

  • soap-api

  • http-api

  • raml-fragment

  • custom

  • connector

  • template

  • example

  • policy

  • app

  • extension

  • external-library

--keywords

キーワード

--dependencies

アセットの連動関係 (「,」で区切る)

次に例を示します。

groupID:assetID:version,groupID2:assetID:version

exchange asset modify

> exchange asset modify [options] <assetIdentifier>

このコマンドは、​<assetIdentifier>​ で識別される Exchange アセットを変更します。
引数 ​assetIdentifier​ は、​([group_id]/)<asset_id>/<version>​ の形式にする必要があります。
group_id​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。

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

コマンド 説明

--name

新しいアセット名

exchange asset modify --name newName --tags test,sample

--tags

アセットのカンマ区切りタグ

exchange asset download

> exchange asset download [options] <assetIdentifier> <directory>

このコマンドは、​<assetIdentifier>​ で識別される Exchange アセットを ​<directory>​ で渡されるディレクトリにダウンロードします。
引数 ​assetIdentifier​ は、​([group_id]/)<asset_id>/<version>​ の形式にする必要があります。
group_id​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。

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

exchange asset list

> exchange asset list [options] [searchText]

このコマンドは、Exchange のすべてのアセットをリストします。

searchText でキーワードを指定して、それらの特定のキーワードが含まれる API のみが結果に表示されるように制限できます。

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

コマンド 説明

--limit

取得する結果の数

exchange asset list --limit 2

--offset

渡された API の数値をオフセットする

exchange asset list --offset 3

--sort

渡された項目名の結果を並び替える

exchange asset list --sort "Latest Version"

exchange asset page download

> exchange asset page download [options] <assetIdentifier> <directory> [pageName]

このコマンドは、​<assetIdentifier>​ で識別される Exchange アセットの ​<pageName>​ で指定される説明ページを ​<directory>​ で渡されるディレクトリにダウンロードします。
[pageName] が指定されていない場合、このコマンドはすべてのページをダウンロードします。

このコマンドでは、パブリッシュ済みページのみがサポートされています。

引数 ​assetIdentifier​ は、​([group_id]/)<asset_id>/<version>​ の形式にする必要があります。
group_id​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。
説明ページは、マークダウン形式でダウンロードされます。​name​ が指定されていない場合、すべてのページがダウンロードされます。

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

exchange asset page modify

> exchange asset page modify [options] <assetIdentifier> <pageName>

このコマンドは、​<assetIdentifier>​ で識別される Exchange アセットの ​<pageName>​ で指定される説明ページを変更します。

このコマンドでは、パブリッシュ済みページのみがサポートされています。

引数 ​assetIdentifier​ は、​([group_id]/)<asset_id>/<version>​ の形式にする必要があります。
group_id​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。
このコマンドでは、デフォルトの ​--help​、​-f​/​--fields​、​-o​/​--output​ オプション以外に、新しいアセットページ名を設定する ​--name​ オプションも使用できます。

exchange asset page upload

> exchange asset page upload [options] <assetIdentifier> <pageName> <mdPath>

このコマンドは、​<pageName>​ で指定される名前を使用して、アセットの説明ページを ​<mdPath>​ で渡されるパスから ​<assetIdentifier>​ で識別される Exchange アセットにアップロードします。
ページの名前を「home」にすると、アップロードされたページが Exchange アセットのメイン説明ページになります。

このコマンドでは、パブリッシュ済みページのみがサポートされています。

引数 ​assetIdentifier​ は、​([group_id]/)<asset_id>/<version>​ の形式にする必要があります。
group_id​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。
このコマンドはデフォルトのオプション ​--help​、​-f​/​--fields​、​-o​/​--output​ のみを受け入れます。

exchange asset page delete

> exchange asset page delete [options] <assetIdentifier> <pageName>

このコマンドは、​<assetIdentifier>​ で識別されるアセットの ​<pageName>​ で指定される説明ページを削除します。

このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
このコマンドでは、パブリッシュ済みページのみがサポートされています。

引数 ​assetIdentifier​ は、​([group_id]/)<asset_id>/<version>​ の形式にする必要があります。
group_id​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。
このコマンドはデフォルトのオプション ​--help​、​-f​/​--fields​、​-o​/​--output​ のみを受け入れます。

exchange asset page list

> exchange asset page list <assetIdentifier>

このコマンドは、​<assetIdentifier>​ で渡されるアセットのすべてのページをリストします。
引数 ​assetIdentifier​ は、​([group_id]/)<asset_id>/<version>​ の形式にする必要があります。
group_id​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。

このコマンドでは、パブリッシュ済みページのみがサポートされています。

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

exchange asset copy

> exchange asset copy [options] <source> <target>

このコマンドは、​<source>​ から ​<target>​ に Exchange アセットをコピーします。
引数 ​<source>​ および ​<target>​ は、​([group_id]/)<asset_id>/<version>​ の形式にする必要があります。
group_id​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。

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

コマンド 説明

--targetOrganizationId

アセットのコピー先となる組織 ID

exchange asset copy --targetOrganizationId organization_id source_group_id/source_asset_id/source_version target_group_id/target_asset_id/target_version

exchange asset delete

> exchange asset delete [options] <assetIdentifier>

このコマンドは、​<assetIdentifier>​ で渡される Exchange アセットを削除します。

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

引数 ​assetIdentifier​ は、​([group_id]/)<asset_id>/<version>​ の形式にする必要があります。
group_id​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。
このコマンドはデフォルトのオプション ​--help​、​-f​/​--fields​、​-o​/​--output​ のみを受け入れます。

exchange asset deprecate

> exchange asset deprecate <assetIdentifier>

このコマンドは、​<assetIdentifier>​ で渡されるアセットを非推奨にします。

引数 ​assetIdentifier​ は、​([group_id]/)<asset_id>/<version>​ の形式にする必要があります。
group_id​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。

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

exchange asset undeprecate

> exchange asset undeprecate <assetIdentifier>

このコマンドは、​<assetIdentifier>​ で渡されるアセットの非推奨を解除します。

引数 ​assetIdentifier​ は、​([group_id]/)<asset_id>/<version>​ の形式にする必要があります。
group_id​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。

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

exchange asset describe

> exchange asset describe <assetIdentifier>

このコマンドは、​<assetIdentifier>​ で渡されるアセットの情報を表示します。

引数 ​assetIdentifier​ は、​([group_id]/)<asset_id>/<version>​ の形式にする必要があります。
group_id​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。

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

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​ の値を使用できます。

--autoRestart

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

--help

使用量情報を出力する

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​ コマンドのプロパティを渡します。 安全な隠しアプリケーションプロパティについては、​「アプリケーションプロパティを安全に隠す」​を参照してください。

runtime-mgr rtf list

> runtime-mgr rtf list [options]

このコマンドは、使用可能な Runtime Fabric インスタンスをリストします。

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

コマンドラインを使用した Runtime Fabric インスタンスの管理については、​「サポートされている rtfctl コマンド」​を参照してください。

runtime-mgr standalone-application artifact

> runtime-mgr standalone-application artifact [options] <identifier> <directory>

このコマンドは、​identifier​ アプリケーションのアプリケーションアーチファクトを ​directory​ で渡されるディレクトリにダウンロードします。 identifier​ パラメータは、アプリケーション ID または名前のいずれかになります。

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

runtime-mgr standalone-application deploy

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

このコマンドは、パス ​zipfile​ の ZIP ファイルとして渡されるアプリケーションを ​targetIdentifier​ で渡されるオンプレミスの対象にデプロイまたは再デプロイします。

targetIdentifier​ パラメータは、対象 ID または名前のいずれかになります。

対象は、サーバ、サーバグループ、クラスタのいずれかになります。

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

アプリケーションを再デプロイしてログレベルを設定したり、インサイトイベント追跡を有効にしたりするには、「​runtime-mgr standalone-application modify​」を参照してください。

runtime-mgr standalone-application describe-json

> runtime-mgr standalone-application describe-json [options] <identifier>

このコマンドでは、​identifier​ で渡されるスタンドアロン (オンプレミス) アプリケーションの情報を未加工の JSON 応答として表示します。

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

runtime-mgr standalone-application modify

> runtime-mgr standalone-application modify [options] <identifier> <zipfile>

このコマンドでは、パスとして ​zipfile​ で渡される ZIP ファイルアプリケーションを使用して、​identifier​ で渡されるスタンドアロン (オンプレミス) アプリケーションを変更します。

identifier​ パラメータでは、アプリケーション識別子を指定します。 識別子を取得するには、「​runtime-mgr standalone-application list​」を参照してください。

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

説明

--insight

各 Mule トランザクションのメッセージメタデータを保存する。

--log [level:scope]

ログレベルとスコープのペアを設定する。

  • level​: TRACE、DEBUG、INFO、WARN、ERROR、FATAL、OFF

  • scope​: 記録するクラス、コネクタ、モジュールのパッケージ名 (FTP 用 Anypoint コネクタの ​org.mule.extension.ftp​ など)

複数のログレベルを設定するには、​--log INFO:org.apache --log WARN:org.mule​ のように複数の ​--log​ オプションを指定します。

runtime-mgr standalone-application start

> runtime-mgr standalone-application start [options] <identifier>

このコマンドでは、​identifier​ で渡されるスタンドアロン (オンプレミス) アプリケーションを開始します。

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

runtime-mgr standalone-application delete

> runtime-mgr standalone-application delete [options] <identifier>

このコマンドでは、​identifier​ で渡されるスタンドアロン (オンプレミス) アプリケーションを削除します。

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

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

runtime-mgr standalone-application describe

> runtime-mgr standalone-application describe [options] <identifier>

このコマンドでは、​identifier​ で渡されるスタンドアロン (オンプレミス) アプリケーションの状況、作成日、最終更新日などの詳細情報を表示します。

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

runtime-mgr standalone-application list

> runtime-mgr standalone-application list [options]

このコマンドでは、すべてのスタンドアロン (オンプレミス) アプリケーションをリストします。

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

説明

--limit <num>

取得する結果の数を指定する

--offset <num>

渡されるアプリケーションの数をオフセットする

runtime-mgr standalone-application restart

> runtime-mgr standalone-application restart [options] <identifier>

このコマンドでは、​identifier​ で渡されるスタンドアロン (オンプレミス) アプリケーションを再起動します。

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

runtime-mgr standalone-application stop

> runtime-mgr standalone-application stop [options] <identifier>

このコマンドでは、​identifier​ で渡されるスタンドアロン (オンプレミス) アプリケーションを停止します。

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

runtime-mgr standalone-application copy

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

このコマンドでは、​source​ で渡されるスタンドアロン (オンプレミス) アプリケーションを ​target​ で渡される対象およびサーバ、サーバグループ、クラスタ ID (​targetIdentifier​ で渡される名前) にコピーします。

source​ と ​destination​ の引数はどちらも、次のように ​<organizationName>:<environmentName>/<appName>​ の形式を使用して表されます。

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

application-1​ という名前のアプリケーションを​サービス​組織の QA 環境からサーバ ID 123456 の​Development​組織の QA 環境にコピーします。

Anypoint Platform CLI でサービス組織の QA 環境を使用する場合、コマンドの ​source​ としてアプリケーション名を使用できます。

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

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

runtime-mgr server describe

> runtime-mgr server describe [options] <serverId>

このコマンドは、​serverId​ で渡されるサーバの情報を表示します。

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

runtime-mgr server modify

> runtime-mgr server modify [options] <serverId>

このコマンドは、​serverId​ で渡されるサーバを変更します。

クラスタの ID を更新するには、​--name​ オプションを渡す必要があります。

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

runtime-mgr server token

> runtime-mgr server token [options]

このコマンドは、サーバ登録トークンを取得します。新しいサーバを登録するには、このトークンを使用する必要があります。

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

runtime-mgr server delete

> runtime-mgr server delete [options] <serverId>

このコマンドは、​serverId​ で渡されるサーバを削除します。

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

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

runtime-mgr server list

> runtime-mgr server list [options]

このサーバは、環境内のすべてのサーバをリストします。

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

runtime-mgr serverGroup create

> runtime-mgr serverGroup create [options] <name> [serverIds...]

このコマンドは、後で引数として渡されるサーバ ID を使用して、​name​ で渡される名前でサーバグループを作成します。

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

runtime-mgr serverGroup describe

> runtime-mgr serverGroup describe [options] <serverGroupId>

このコマンドは、​serverGroupId​ で渡されるサーバグループの情報を表示します。

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

runtime-mgr serverGroup modify

> runtime-mgr serverGroup modify [options] <serverGroupId>

このコマンドは、​serverGroupId​ で渡されるサーバグループを変更します。

クラスタの ID を更新するには、​--name​ オプションを渡す必要があります。

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

runtime-mgr serverGroup add server

> runtime-mgr serverGroup add server [options] <serverGroupId> <serverId>

このコマンドは、​serverId​ で渡されるサーバを ​serverGroupId​ で渡されるサーバグループに追加します。

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

runtime-mgr serverGroup delete

> runtime-mgr serverGroup delete [options] <serverGroupId>

このコマンドは、​serverGroupId​ で渡されるサーバグループを削除します。

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

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

runtime-mgr serverGroup list

> runtime-mgr serverGroup list [options]

このコマンドは、環境内のすべてのサーバグループをリストします。

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

runtime-mgr serverGroup remove server

> runtime-mgr serverGroup remove server [options] <serverGroupId> <serverId>

このコマンドでは、​serverGroupId​ で渡されるサーバグループから ​serverId​ で渡されるサーバを削除します。

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

runtime-mgr cluster add server

> runtime-mgr cluster add server [options] <clusterId> <serverId>

このコマンドは、​clusterId​ のクラスタを ​serverId​ で渡されるサーバに追加します。

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

runtime-mgr cluster delete

> runtime-mgr cluster delete [options] <clusterId>

このコマンドは、​clusterId​ で渡されるクラスタを削除します。

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

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

runtime-mgr cluster list

> runtime-mgr cluster list [options]

このコマンドは、環境内のすべてのクラスタをリストします。

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

runtime-mgr cluster remove server

> runtime-mgr cluster remove server [options] <clusterId> <serverId>

このコマンドは、​clusterId​ で渡されるクラスタから ​serverId​ で渡されるサーバを削除します。

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

runtime-mgr cluster create

> runtime-mgr cluster create [options] <name>

このコマンドは、​name​ で渡される ID を使用してクラスタを作成します。

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

説明

--multicast

クラスタをマルチキャストにする必要があるかどうか

--server <id:ip>

サーバ ID と IP アドレスのペア。マルチキャストクラスタの場合、後者は省略可能です。複数のサーバを追加するには、複数の値を指定します。

runtime-mgr cluster describe

> runtime-mgr cluster describe [options] <clusterId>

このコマンドは、​clusterId​ で渡されるクラスタの情報を表示します。

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

runtime-mgr cluster modify

> runtime-mgr cluster modify [options] <clusterId>

このコマンドは、​clusterId​ で渡されるクラスタを変更します。
クラスタの ID を更新するには、​--name​ オプションを渡す必要があります。

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

runtime-mgr standalone-alert describe

> runtime-mgr standalone-alert describe [options] <alertId>

このコマンドは、​alertId​ で渡されるアラートの情報を表示します。

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

runtime-mgr standalone-alert create

> runtime-mgr standalone-alert create [options] <name>

このコマンドは、​name​ で渡される ID を使用して、スタンドアロンランタイムの新しいアラートを作成します。 アラート ​name​ は 256 文字に制限されます。

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

説明

--severity <val>

アラートの重要度

--resourceType <type>

アラートのリソース種別

--resource [id]

アラートのリソース ID。複数回使用できます。指定されていない場合、すべてのリソースでアラートがトリガされます。​resourceType​ に応じて、リソースはアプリケーション、サーバ、サーバグループ、クラスタになります。

--condition <val>

アラートのトリガ条件

--period [minutes]

条件の期間 (分)

--threshold [num]

条件のしきい値

--operator [type]

しきい値に関する値を記述する条件演算子。

--subject <string>

アラート通知メールの件名

--content <string>

アラート通知メールの本文

--recipient [username]

アラート通知を送信するユーザ名。複数回使用して、最大 20 件のプラットフォームユーザ ID を指定できます。

--email [emailAddress]

アラート通知を送信するメールアドレス。複数回使用して、最大 20 件のメールアドレスを指定できます。

runtime-mgr standalone-alert modify

> runtime-mgr standalone-alert modify [options] <alertId>

このコマンドは、​alertId​ で渡されるアラートを変更します。

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

説明

--name <value>

アラート名

--severity <value>

アラートの重要度

--resourceType <type>

アラートのリソース種別

--resource [id]

アラートのリソース ID。複数回使用できます。指定されていない場合、すべてのリソースでアラートがトリガされます。​resourceType​ に応じて、リソースはアプリケーション、サーバ、サーバグループ、クラスタになります。

--condition <value>

アラートのトリガ条件

--period [minutes]

条件の期間 (分)

--threshold [num]

条件のしきい値

--operator [type]

しきい値に関する値を記述する条件演算子。

--subject <string>

アラート通知メールの件名

--content <string>

アラート通知メールの本文

--recipient [username]

アラート通知を送信するユーザ名。複数回使用して、最大 20 件のプラットフォームユーザ ID を指定できます。

--email [emailAddress]

アラート通知を送信するメールアドレス。複数回使用して、最大 20 件のメールアドレスを指定できます。

runtime-mgr standalone-alert list

> runtime-mgr standalone-alert list [options]

このコマンドは、現在の環境のスタンドアロン Mule のすべてのアラートをリストします。

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

cloudhub load-balancer list

> cloudhub load-balancer list [options]

このコマンドは、Anypoint Platform のすべてのロードバランサをリストします。ロードバランサの名前、ドメイン、その状態、およびロードバランサがバインドされている Anypoint VPC ID を表示します。

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

cloudhub load-balancer describe

> cloudhub load-balancer describe [options] <name>

このコマンドは、​<name>​ で指定されるロードバランサに関する情報を表示します。

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

ロードバランサの名前、ドメイン、その状態、およびロードバランサがバインドされている Anypoint VPC ID を表示します。

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

cloudhub load-balancer describe-json

> cloudhub load-balancer describe [options] <name>

このコマンドでは、​<name>​ で指定されるロードバランサの未加工の JSON 応答を表示します。

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

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

cloudhub load-balancer create

> cloudhub load-balancer create [options] <vpc> <name> <certificate> <privateKey>

このコマンドは、環境変数で指定される値を使用してロードバランサを作成します。

説明

vpc

このロードバランサがバインドされる Anypoint VPC の名前。
Anypoint VPC 名にスペースが含まれている場合、「"」文字で囲んで渡す必要があります。

vpc-demo

name

ロードバランサの名前。

newtestloadbalancer

certificate

ローカルハードドライブのサーバ証明書の ​.pem​ ファイルへの絶対パス。
証明書ファイルは、暗号化せずに PEM でエンコードする必要があります。

/Users/mule/Documents/cert.pem

privateKey

ローカルハードドライブのサーバ証明書の非公開鍵の ​.pem​ ファイルへの絶対パス。
非公開鍵ファイルは、パスフレーズレスである必要があります。

/Users/mule/Documents/privateKey.pem

<name>​ で渡すロードバランサの名前は一意である必要があります。
デフォルトでは、ロードバランサは HTTPS で外部要求をリスンし、HTTP で内部的にワーカーと通知します。
HTTPS でリスンするように Anypoint VPC 内の Mule アプリケーションを設定している場合、​​load-balancer mappings add​ コマンドを使用してマッピングリストを作成するときに ​upstreamProtocol​ が HTTPS に設定されていることを確認してください。

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

説明

http

ロードバランサの HTTP 動作を指定する。これは ​on​ (HTTP 要求を受け入れて、設定したデフォルトの ​sslendpoint​ に転送する)、​off​ (すべての HTTP 要求を拒否する)、または ​redirect​ (HTTPS にリダイレクトする) に設定できます。

clientCertificate

クライアント証明書ファイル

verificationMode

クライアント検証モードを指定する。​on​ (常に検証)、​off​ (検証しない)、または ​optional​ (検証は省略可能) に設定できます。

crl

証明書失効リストファイル

tlsv1

TLSv1、TLSv1.1、TLSv1.2 をサポートする

dynamic-ips

再起動後は保持されない動的 IP を使用する。

CloudHub は、オンライン証明書状況プロトコル (OCSP) を実装しません。証明書失効リストを最新の状態に保つには、 CloudHub API​ を使用してプログラムで証明書を更新することをお勧めします。

設定についての詳細は、専用​ロードバランサ​ページの​証明書セクション​を参照してください。

cloudhub load-balancer start

> cloudhub load-balancer start [options] <name>

このコマンドは、​<name>​ で指定されるロードバランサを開始します。
このコマンドでは、デフォルトのオプション (​--help​、​-f​/​--fields​、​-o​/​--output​) 以外のオプションは使用できません。

cloudhub load-balancer stop

> cloudhub load-balancer stop [options] <name>

このコマンドは、​<name>​ で指定されるロードバランサを停止します。
このコマンドでは、デフォルトのオプション (​--help​、​-f​/​--fields​、​-o​/​--output​) 以外のオプションは使用できません。

cloudhub load-balancer delete

> cloudhub load-balancer delete [options] <name>

このコマンドは、​<name>​ で指定されるロードバランサを削除します。

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

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

cloudhub load-balancer ssl-endpoint add

> cloudhub load-balancer ssl-endpoint add [options] <name> <certificate> <privateKey>

このコマンドは、渡される証明書と非公開鍵を使用して、SSL エンドポイントを ​<name>​ で指定されるロードバランサに追加します。

説明

name

ロードバランサの名前。

newtestloadbalancer

certificate

ローカルハードドライブの証明書の ​.pem​ ファイルへの絶対パス。
証明書ファイルは、暗号化せずに PEM でエンコードする必要があります。

/Users/mule/Documents/cert.pem

privateKey

ローカルハードドライブの非公開鍵の ​.pem​ ファイルへの絶対パス。
非公開鍵ファイルは、パスフレーズレスである必要があります。

/Users/mule/Documents/privateKey.pem

CloudHub は、オンライン証明書状況プロトコル (OCSP) を実装しません。証明書失効リストを最新の状態に保つには、 CloudHub API​ を使用してプログラムで証明書を更新することをお勧めします。

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

説明

clientCertificate

クライアント証明書ファイル

verificationMode

クライアント検証モードを指定する。​on​ (常に検証)、​off​ (検証しない)、または ​optional​ (検証は省略可能) に設定できます。

crl

証明書失効リストファイル

tlsv1

TLSv1、TLSv1.1、TLSv1.2 をサポートする

設定に関する詳細は、​「SSL エンドポイントと証明書の設定」​を参照してください。

cloudhub load-balancer ssl-endpoint remove

> cloudhub load-balancer ssl-endpoint remove [options] <name> <certificateName>

このコマンドは、​<name>​ で指定されるロードバランサから ​<certificateName>​ で指定される SSL 証明書を削除します。

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

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

cloudhub load-balancer ssl-endpoint set-default

> cloudhub load-balancer ssl-endpoint set-default [options] <name> <certificateName>

このコマンドは、​<name>​ で渡されるロードバランサのデフォルトの証明書として ​<certificateName>​ で指定される証明書を設定します。

ロードバランサの名前の入力を開始して ​tab​ キーを押すと、Anypoint Platform CLI によって名前がオートコンプリートされます。また、​tab​ キーをダブルタップすると、渡すことができるすべての値の完全なリストが表示されます。
このコマンドでは、デフォルトの ​--help​、​-f​/​--fields​、​-o​/​--output​ オプション以外に次のオプションも使用できます。

説明

http

ロードバランサの HTTP 動作を指定する

cloudhub load-balancer ssl-endpoint describe

> cloudhub load-balancer ssl-endpoint describe [options] <name> <certificateName>

このコマンドは、​<certificateName>​ で指定される証明書の ​<name>​ で渡されるロードバランサの設定に関する情報を表示します。
ロードバランサの名前の入力を開始して ​tab​ キーを押すと、Anypoint Platform CLI によって名前がオートコンプリートされます。また、​tab​ キーをダブルタップすると、渡すことができるすべての値の完全なリストが表示されます。

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

cloudhub load-balancer whitelist add

> cloudhub load-balancer whitelist add [options] <name> <cidrBlock>

このコマンドでは、​<cidrBlock>​ で指定される IP アドレスの範囲を ​<name>​ で指定されるロードバランサの許可リストに追加します。

許可リストは、CN 証明書レベルではなく、ロードバランサレベルで動作します。​CIDR 表記の形式の IP アドレスのみを渡してください。

ロードバランサの名前の入力を開始して ​tab​ キーを押すと、Anypoint Platform CLI によって名前がオートコンプリートされます。また、​tab​ キーをダブルタップすると、渡すことができるすべての値の完全なリストが表示されます。
このコマンドでは、デフォルトのオプション (​--help​、​-f​/​--fields​、​-o​/​--output​) 以外のオプションは使用できません。

cloudhub load-balancer whitelist remove

> cloudhub load-balancer whitelist remove <name> <cidrBlock>

このコマンドでは、​<cidrBlock>​ で指定される IP または IP アドレスの範囲を ​<name>​ で指定されるロードバランサの許可リストから削除します。

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

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

cloudhub load-balancer mappings describe

> cloudhub load-balancer mappings describe <name> [certificateName]

このコマンドは、​<name>​ で指定されるロードバランサのマッピングルールをリストします。
certificateName​ が渡されない場合、Anypoint Platform CLI はデフォルトの SSL エンドポイントのマッピングを返します。

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

cloudhub load-balancer mappings add

> cloudhub load-balancer mappings add [options] <name> <index> <inputUri> <appName> <appUri> [certificateName]

このコマンドは、​certificateName​ オプションで渡される CN の ​<index>​ で指定される優先度インデックスで、​<name>​ で指定されるロードバランサにプロキシマッピングルールを追加します。
certificateName​ が渡されない場合、Anypoint Platform CLI はマッピングをデフォルトの SSL エンドポイントに追加します。

説明

name

ルールが適用されるロードバランサの名前。

testloadbalancer

index

ルールの優先度。

1

inputUri

入力 URL の URI の名前

example.com

appName

要求が転送される出力 URL のアプリケーションの名前

{app}-example

appUri

要求が転送される出力 URL のアプリケーションの URI

/

上の例の値の場合、​my-superapp.api.example.com/status?limit=10​ への入力コールでアプリケーションのエンドポイント ​my-superapp-example: /status?limit=10​ がコールされます。

このコマンドでは、​--upstreamProtocol​ オプションも使用できます。 --upstreamProtocol​ オプションは、内部的にロードバランサと通信するためにアプリケーションで使用されるプロトコルを設定します。アップストリームプロトコルが設定されていない場合、HTTP がデフォルトとして使用されます。

オプション 説明

--upstreamProtocol <protocol>

HTTP ポート 8091 または HTTPS ポート 8092 でアップストリームアプリケーションを確認する。 サポートされている値: http​、​https

--certificateName <certificate name>

省略可能なパラメータ

cloudhub load-balancer mappings remove

> cloudhub load-balancer mappings remove [options] <name> <index> [certificateName]

このコマンドは、​<index>​ で指定される優先度インデックスおよび ​certificateName​ オプションとして指定される CN で、​<name>​ で指定されるロードバランサからプロキシマッピングルールを削除します。

このコマンドでは、デフォルトのオプション (​--help​、​-f​/​--fields​、​-o​/​--output​) 以外のオプションは使用できません。​certificateName​ が渡されない場合、Anypoint Platform CLI はデフォルトの SSL エンドポイントのマッピングを削除します。

cloudhub load-balancer dynamic-ips enable

> cloudhub load-balancer dynamic-ips enable [options] <name>

このコマンドは、​<name>​ で指定されるロードバランサの動的 IP を有効にします。 このコマンドでは、デフォルトのオプション (​--help​、​-f​/​--fields​、​-o​/​--output​) 以外のオプションは使用できません。

cloudhub load-balancer dynamic-ips disable

> cloudhub load-balancer dynamic-ips disable [options] <name>

このコマンドは、​<name>​ で指定されるロードバランサの動的 IP を無効にします。 このコマンドでは、デフォルトのオプション (​--help​、​-f​/​--fields​、​-o​/​--output​) 以外のオプションは使用できません。

cloudhub region list

> cloudhub region list [options]

このコマンドは、サポートされているすべてのリージョンをリストします。

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

cloudhub runtime list

> cloudhub runtime list [options]

このコマンドは、サポートされているすべてのランタイムをリストします。

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

cloudhub vpc list

> cloudhub VPC list [options]

このコマンドは、使用可能なすべての Anypoint VPC をリストします。ID、リージョン、ネットワークの環境、およびデフォルトの Anypoint VPC かどうかを返します。

cloudhub vpc describe

> cloudhub vpc describe [options] <name>

このコマンドは、​<name>​ で指定される Anypoint VPC に関する情報を表示します。

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

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

cloudhub vpc describe-json

> cloudhub vpc describe [options] <name>

このコマンドは、​<name>​ で指定される Anypoint VPC の未加工の JSON 応答を表示します。

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

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

cloudhub vpc create

> cloudhub vpc create [options] <name> <region> <cidrBlock> [environments...]

このコマンドは、クラスレスインタードメインルーティング (CIDR) ブロック形式 (CIDR 表記を使用) の ​<cidrBlock>​ で渡される​サイズ​で ​<name>​ の名前を使用して ​<region>​ で指定されるリージョンに Anypoint VPC を作成し、後で引数として渡される​環境​に関連付けます。

Anypoint VPC は、組織内のビジネスグループにバインドされている必要があります。Anypoint VPC を作成するときに ​​ business-groups add​ コマンドを使用して、ビジネスグループに割り当ててください。

このコマンドでは、デフォルトの ​--help​ オプション以外に ​--default​ オプションも使用できます。渡されると、Anypoint VPC は選択された環境のデフォルトの Anypoint VPC として作成されます。

cloudhub vpc delete

> cloudhub vpc delete <name>

このコマンドは、​<name>​ で指定される Anypoint VPC を削除します。

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

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

cloudhub vpc environments add

> cloudhub vpc environments add [options] <vpc> [environments...]

このコマンドは、​<vpc>​ で定義される Anypoint VPC を、後で引数として渡される環境に割り当てます。
--default​ オプションでは、Anypoint VPC を組織のデフォルトとして設定できます。これは、Anypoint VPC が明示的に関連付けられていないすべての環境に適用されます。

このコマンドでは、デフォルトの ​--help​ オプションも使用できます。

cloudhub vpc environments remove

> cloudhub vpc environments remove [options] <vpc> [environments...]

このコマンドは、​<vpc>​ で定義される Anypoint VPC を、後で引数として渡される環境から削除します。
このコマンドでは、デフォルトの ​--help​ オプション以外に、この Anypoint VPC を環境のデフォルトの Anypoint VPC として削除する ​--default​ オプションも使用できます。

cloudhub vpc business-groups add

> cloudhub vpc business-groups add [options] <vpc> <businessGroups...>

このコマンドは、​<vpc>​ で定義される Anypoint VPC を、後で引数として渡されるビジネスグループに割り当てます。

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

cloudhub vpc business-groups remove

> cloudhub vpc business-groups remove [options] <vpc> <businessGroups...>

このコマンドは、​<vpc>​ で定義される Anypoint VPC を、後で引数として渡されるビジネスグループから削除します。

このコマンドは、指定されたリソースから Anypoint VPC を削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。

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

cloudhub vpc dns-servers set

> cloudhub vpc dns-servers set [options] <vpc>

このコマンドは、非公開アドレスでも公開アドレスでも IP アドレスを指定する必要がある DNS サーバを使用して解決されるローカルホスト名 (内部ドメイン名) のリストを設定します。
それらの非公開ドメインが指定されている場合、ワーカーは非公開 DNS を使用して解決するため、非公開ネットワークの内部ホスト名を引き続き使用できます。

この機能は、Mule バージョン 3.5.x、3.6.x、3.7.4、3.8.0-HF1、3.8.1、3.8.2 を実行しているワーカーでサポートされます。

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

オプション 説明

server

特殊なドメインを解決する DNS サーバの IP アドレス。最大 3 回指定できます。

domain

特殊な DNS サーバリストで解決するドメイン。複数回指定できます。

ドメインは任意の数、IP アドレスは最大 3 個渡すことができます。
例: $ cloudhub vpc dns-servers set --domain example.com --server 192.168.1.10 <VPC Name>​。

このコマンドを実行するたびに、以前の DNS セットコマンドは上書きされます。
DNS セットを削除するには、​​vpc dns-servers unset​ コマンドを使用する必要があります。

cloudhub vpc dns-servers unset

> cloudhub vpc dns-servers unset [options] <vpc>

このコマンドは、​<vpc>​ で渡される Anypoint VPC の DNS サーバを使用して解決されるローカルホスト名 (内部ドメイン名) のリストをクリアします。

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

cloudhub vpc firewall-rules describe

> cloudhub vpc firewall-rules describe <vpc>

このコマンドは、​<vpc>​ で定義される Anypoint VPC のすべてのファイアウォールルールの情報を表示します。

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

cloudhub vpc firewall-rules add

> cloudhub vpc firewall-rules add [options] <vpc> <cidrBlock> <protocol> <fromPort> [toPort]

このコマンドは、変数で設定される値を使用して、​<vpc>​ で定義される Anypoint VPC にファイアウォールルールを追加します。

説明

vpc

このロードバランサがバインドされる Anypoint VPC の名前。
Anypoint VPC 名にスペースが含まれている場合、「"」文字で囲んで渡す必要があります。

vpc-demo

cidrBlock

ファイアウォールで許可する CIDR 表記の IP アドレス。

192.0.1.0/27

protocol

ルールで使用するプロトコル。​tcp​ または ​udp​ になります。

tcp

fromPort

ファイアウォールで要求を許可するポート。(0 ~ 65535)。

8888

toPort

省略可能​。ポート範囲が必要な場合、​fromPort​ および ​toPort​ 変数でそのような範囲を定義します。

8090

Anypoint VPC を作成するときにアウトバウンドアドレスを許可してください。
デフォルトでは、すべての IP アドレスがブロックされるため、Anypoint VPC ファイアウォールルールに対して IP アドレスまたはアドレスの範囲を承認する必要があります。

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

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

cloudhub vpc firewall-rules remove

> cloudhub vpc firewall-rules remove <vpc> <index>

このコマンドは、​<index>​ で渡されるインデックスで、​<vpc>​ で指定される Anypoint VPC 内のワーカーからファイアウォールルールを削除します。

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

use environment

このコマンドは、対話型モードでのみ使用できます。

> use environment [options] <name>

このコマンドは、​<name>​ で指定される環境をアクティブにします。

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

use business-group

このコマンドは、対話型モードでのみ使用できます。

> use business-group  [options] <name>

このコマンドは、​<name>​ で指定されるビジネスグループをアクティブにします。

ビジネスグループまたは組織名にスペースが含まれている場合、その名前を ​"​ 文字で囲む必要があります。

> use business-group "QA Organization"

exit

> exit [options]

このコマンドは、Anypoint Platform CLI を終了します。

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

Was this article helpful?

💙 Thanks for your feedback!