# mulesoft Anypoint Cli - Full Documentation # Anypoint CLI 3.x Anypoint Platform には、Anypoint Platform と Anypoint Platform Private Cloud Edition (Anypoint Platform PCE) のスクリプトおよびコマンドラインツールが用意されています。 コマンドラインインターフェース (CLI) は、対話型シェルと標準 CLI モードの両方をサポートしており、以下で動作します。 - [Anypoint Exchange](https://docs.mulesoft.com/jp/exchange/) - [Anypoint DataGraph](https://docs.mulesoft.com/jp/datagraph/) - [アクセス管理](https://docs.mulesoft.com/jp/access-management/) - [Anypoint Runtime Manager](https://docs.mulesoft.com/jp/runtime-manager/) - [API Governance](https://docs.mulesoft.com/api-governance/) Runtime Manager を使用して (MuleSoft でホストされている) CloudHub とローカルにホストされている Mule サーバーにデプロイされている Mule アプリケーションを管理します。 - [VPC](https://docs.mulesoft.com/cloudhub/virtual-private-cloud) - [CloudHub ロードバランサー](https://docs.mulesoft.com/cloudhub/cloudhub-dedicated-load-balancer) - [API Manager 2.x (Crowd リリース)](https://docs.mulesoft.com/jp/api-manager/latest/) - [Design Center](https://docs.mulesoft.com/design-center/) ## [](#prereqs)前提条件 - NodeJS と npm (ノードパッケージマネージャー) をシステムにダウンロードしてインストールします。 必要な最小バージョン: Node.js バージョン 16.0.0 ~ 18.14.0 および npm 6.14.8 [NodeJS のダウンロードページ](https://nodejs.org/en/download/)​を参照してください。 - Git バージョン管理をシステムにダウンロードしてインストールします。 [Git のダウンロードサイト](https://git-scm.com/downloads)​を参照してください。
システムの設定によっては、システム管理者のログイン情報を使用して、次のコマンドを実行することが必要になる場合もあります。
## [](#installation)インストール ```text $ npm install -g anypoint-cli@latest ```
システムの設定によっては、システム管理者のログイン情報を使用して、次のコマンドを実行することが必要になる場合もあります。
## [](#authentication)認証 ユーザー名とパスワード、クライアント ID とクライアントシークレット、またはベアラートークンを使用するように Anypoint CLI 認証を設定できます。 いずれか 1 つ以上の方法を設定する必要があります。
2022 年 10 月以降、すべてのユーザーに対する多要素認証 (MFA) の有効化の一環として、Anypoint CLI を使用する方法は​接続アプリケーション​経由のみになります。
### [](#username-pw)ユーザー名とパスワード シングルサインオン (SSO) を使用してログインしない場合は、ユーザー名とパスワードを使用して CLI に直接ログインできます。
パラメーター 説明

username

Anypoint Platform ユーザー名

環境変数 ​export ANYPOINT_USERNAME=<name>​ を使用して、この値を渡すこともできます。

password

Anypoint Platform パスワード

環境変数 ​export ANYPOINT_PASSWORD=<pwd>​ を使用して、この値を渡すこともできます。

SSO を使用したログインの詳細は、​[「ID 管理について」](https://docs.mulesoft.com/jp/access-management/external-identity)​を参照してください。 ### [](#client-id-secret)クライアント ID とクライアントシークレット `client_credentials`​ 許可種別を使用して、CLI で使用する接続アプリケーションを設定できます。
パラメーター 説明

client_id

接続アプリケーションの ID

環境変数 ​export ANYPOINT_CLIENT_ID=<client_id>​ を使用して、この値を渡すこともできます。

client_secret

接続アプリケーションのクライアントシークレット

環境変数 ​export ANYPOINT_CLIENT_SECRET=<client_secret>​ を使用して、この値を渡すこともできます。

接続アプリケーションについての詳細は、​[「接続アプリケーション」](https://docs.mulesoft.com/jp/access-management/connected-apps-overview)​を参照してください。 ### [](#bearer-token)ベアラートークン すでにベアラートークンを生成してある場合は、直接 CLI に渡すことができます。 ベアラートークンを提供した場合、CLI は他に提供されているすべてのユーザーログイン情報やクライアントログイン情報を無視します。
パラメーター 説明

bearer

Anypoint Platform 用のベアラートークン

ベアラートークンの有効期限が切れると、CLI セッションの有効期限が切れます。

ベアラートークンの生成については、 [「How to generate your Authorization Bearer token for Anypoint Platform (Anypoint Platform 用の認証ベアラートークンの生成方法)」](https://help.mulesoft.com/s/article/How-to-generate-your-Authorization-Bearer-token-for-Anypoint-Platform)​を参照してください。 ## [](#optional-args)省略可能な引数 Anypoint CLI は、以下の省略可能な引数を取ります。
パラメーター 説明

organization

Anypoint Platform 内の組織

環境変数 ​export ANYPOINT_ORG=<name>​ を使用して、この値を渡すこともできます。

environment

自分の Anypoint Platform 環境

環境変数 ​export ANYPOINT_ENV=<name>​ を使用して、この値を渡すこともできます。

host

Anypoint Platform インストールのホスト
デフォルトでは、この値は ​anypoint.mulesoft.com​ を参照します。

  • Anypoint Platform PCE を使用している場合、プラットフォームをホストしているアドレスを渡していることを確認します。

  • Anypoint Platform EU クラウドを使用している場合は、EU コントロールプレーンアドレスを渡します。

専用の環境変数 ​ANYPOINT_HOST=<name>​ を使用して、この値を渡すこともできます。

## [](#cli-usage)使用方法 Anypoint CLI を使用する場合は、次の点に留意してください。 1. 環境変数はログイン情報ファイルパラメーターよりも優先され、コマンドラインパラメーターは環境変数よりも優先されます。 コマンドラインパラメーターを渡さない場合、デフォルトプロファイルのプロパティが使用されます。 2. 指定されていない場合、デフォルト環境は本番です。 3. Anypoint セッションの有効期限は、組織の設定の ​**\[Default session timeout (デフォルトセッションタイムアウト)\]**​ に基づいています。 組織の設定についての詳細は、​[「ルート組織設定を管理する」](https://docs.mulesoft.com/jp/access-management/organization#manage-root-organization-settings)​を参照してください。 4. Anypoint CLI は、オートコンプリートと連動します。 コマンドまたはパラメーターの名前の入力を開始してから Tab キーを押すと、オートコンプリートが実行されます。また、Tab+Tab キーを押すと、オプションのリストが表示されます。 ### [](#credentials-file)ログイン情報ファイル これらのオプションを Anypoint Platform CLI インストールに渡すには、​`~/.anypoint`​ ディレクトリ内にある ​`credentials`​ ファイルを使用することをお勧めします。このファイルは、インストール時に自動的に作成されません。ログイン情報ファイルを作成する手順は、次のとおりです。 1. Linux および OSx では ​`~/`​ ディレクトリ、Windows では ​`C:\Users\USERNAME \`​ に ​`.anypoint`​ というディレクトリを作成します。 2. `.anypoint`​ ディレクトリに移動し、次の構造の ​`credentials`​ という名前の空白のファイルを作成します。 ```text { "default": { "username": "yourAnypointUserName", "password": "yourAnypointPassword", "organization": "", "environment": "", "host": "" }, "otherProfile": { "username": "", "password": "", "organization": "", "environment": "", "host": "" }, "connAppProfile": { "client_id": "", "client_secret": "", "organization": "", "environment": "", "host": "" } } ``` `ANYPOINT_PROFILE`​ 環境変数が設定されていないと、​`default`​ プロファイルが使用されます。 ```text > export ANYPOINT_PROFILE="otherProfile" > anypoint-cli ``` 次に、オプションを指定せずに ​`anypoint-cli`​ コマンドを実行します。 ```text > anypoint-cli ``` ### [](#env-variables)専用の環境変数 `anypoint-cli`​ の実行時にログイン情報を渡す場合、両方のパラメーターを環境変数 ​`ANYPOINT_USERNAME`​ および ​`ANYPOINT_PASSWORD`​ として渡します。 ```text > export ANYPOINT_USERNAME="username" > export ANYPOINT_PASSWORD="password" > anypoint-cli ``` ### [](#cli-options)CLI オプション ユーザー名のみを渡すと、Anypoint CLI からパスワードが求められます。 ```text > anypoint-cli --username="user" Password: **** ``` ### [](#pass-commands)コマンドを渡す CLI から Anypoint Platform にアクセスする適切な方法をセットアップしたら、コマンドを渡すことができます。 これらの使用方法の手順については、​[「Anypoint Platform CLI 3.x のコマンドリスト」](https://docs.mulesoft.com/jp/anypoint-cli/3.x/anypoint-platform-cli-commands)​を参照してください。 ### [](#network-proxy)ネットワークプロキシ経由での Anypoint CLI の使用 Anypoint CLI をプロキシサーバー経由で使用するには、​`HTTP_PROXY`​ および ​`HTTPS_PROXY`​ (大文字) 環境変数を設定して、プロキシサーバーのホスト名と IP アドレスを指定します。 使用しているオペレーティングシステムに応じて、次のいずれかのコマンドを使用します。 - Linux、macOS、または Unix `$ export HTTP_PROXY=http://​_proxy-server_​:80` または `$ export HTTPS_PROXY=https://​_proxy-server_​:443` - Windows `> set HTTP_PROXY=http://​_proxy-server_​:80` または `> set HTTPS_PROXY=https//​_proxy-server_​:443` プロキシサーバーで認証が必要な場合は、次のコマンドを使用してください。 - Linux、macOS、または Unix `$ export HTTP_PROXY=http://​_username_​:_password_​@​_proxy-server_​:80` または `$ export HTTPS_PROXY=https://​_username_​:_password_​@​_proxy-server_​:443` - Windows `> set HTTP_PROXY=http://​_username_​:_password_​@​_proxy-server_​:80` または `> set HTTPS_PROXY=https://​_username_​:_password_​@​_proxy-server_​:443` ## [](#notes)注意事項 - Anypoint CLI 環境を改善するために、匿名化された使用状況データが収集されます。​`credentials`​ ファイルで ​`collectMetrics`​ を false に設定することでオプトアウトできます。 ## [](#関連情報)関連情報 - [Anypoint Platform CLI のコマンドリスト](https://docs.mulesoft.com/jp/anypoint-cli/3.x/anypoint-platform-cli-commands) # Anypoint CLI 3.x コマンドリスト Anypoint Platform CLI で Anypoint Platform の次の機能を管理できます。 - [Anypoint Platform アカウント](#account) - [環境とビジネスグループ](#env-business-groups) - [API Governance](#api-governance) - [API Manager](#api-mgr) - [Cloudhub 2.0](#cloudhub2-apps) - [CloudHub アプリケーション](#cloudhub-apps) - [CloudHub 専用ロードバランサー](#cloudhub-dlb) - [CloudHub Anypoint VPC](#cloudhub-vpc) - [DataGraph ロードバランサー](#datagraph-load-balancers) - [DataGraph API ソース管理](#datagraph-source) - [Design Center プロジェクト](#design-center) - [Exchange アセット](#exchange-assets) - [ハイブリッドアプリケーション](#standalone-apps) - [ハイブリッドアプリケーションのアラート](#standalone-alerts) - [ローカルサーバー](#servers) - [ローカルサーバーグループ](#server-groups) - [ローカルクラスターサーバー](#server-clusters) - [\[rtf-apps\]](#rtf-apps) - [Runtime Fabric インスタンス](#rtf-instances) ## [](#account)Anypoint Platform アカウント
コマンド 説明

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

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

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

環境をリストする

新しい環境を作成する

環境を削除する

環境の詳細を表示する

## [](#env-business-groups)環境とビジネスグループ
コマンド 説明

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

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

## [](#api-governance)API Governance

コマンド

説明

governance api evaluate

検索条件を評価して、その条件を満たす API に適用されるルールセットを決定する

governance api inspect

API 定義を調べ、そのスキーマをリストする

governance api validate

指定されたガバナンスルールセットに対して API 定義を検証する

governance document

ガバナンスルールセット定義のドキュメントファイルを作成する

governance profile create

ガバナンスプロファイルを作成する

governance profile delete

ガバナンスプロファイルを削除する

governance profile info

特定のガバナンスプロファイル ID の情報をリストする

governance profile list

組織内のすべてのガバナンスプロファイルをリストする

governance profile update

ガバナンスプロファイルを更新する

governance ruleset clone

ガバナンスルールセットをコピーし、指定された更新をルールに適用する

governance ruleset info

ルールセットルールをリストする

governance ruleset init

データスキーマに基づいてガバナンスルールセット定義を初期化する

governance ruleset validate

ガバナンスルールセット定義の形式を検証する

## [](#api-mgr)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 層をリストする

## [](#cloudhub2-apps)Cloudhub 2.0
コマンド 説明

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

Exchange アプリケーションを使用して指定された対象にアプリケーションをデプロイし、指定されたランタイムバージョンを実行する

アプリケーションの情報を表示する

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

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

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

デプロイ済みのアプリケーションを修正する

停止中のアプリケーションを開始する

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

仕様のアプリケーションのログを追跡する

## [](#cloudhub-apps)CloudHub アプリケーション
コマンド 説明

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

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

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

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

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

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

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

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

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

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

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

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

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

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

## [](#cloudhub-dlb)CloudHub 専用ロードバランサー
コマンド 説明

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

動的 IP を有効にする

動的 IP を無効にする

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

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

## [](#cloudhub-vpc)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 アプリケーションのファイアウォールルールを削除する

## [](#datagraph-load-balancers)DataGraph ロードバランサー
コマンド 説明

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

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

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

## [](#datagraph-source)DataGraph API ソース管理
コマンド 説明

API ソースを追加する

API ソースを昇格する

API ソースを更新する

統合スキーマに対する API コールをスケーリングする

統合スキーマをダウンロードする

API ソースを削除する

API ソースを取得する

すべての API ソースをリストする

DataGraph に関する情報を返す

## [](#design-center)Design Center プロジェクト
コマンド 説明

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

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

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

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

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

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

## [](#exchange-assets)Exchange アセット
コマンド 説明

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

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

既存の Exchange アセットの変更可能なデータを変更する

Exchange アセットを変更する

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

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

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

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

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

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

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

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

Exchange アセットをコピーする

Exchange のアセットを削除する

アセットを非推奨にする

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

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

アセットポータルにリソースをアップロードする

アセットポータルでパブリッシュ済みのリソースをリストする

アセットポータルからリソースをダウンロードする

アセットポータルからリソースを削除する

## [](#standalone-apps)ハイブリッドアプリケーション
Anypoint Platform CLI で対象サーバーを認識できるように、手動で各サーバーをプラットフォームに登録する必要があります。
コマンド 説明

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

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

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

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

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

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

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

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

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

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

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

## [](#standalone-alerts)ハイブリッドアプリケーションのアラート
コマンド 説明

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

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

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

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

## [](#servers)ローカルサーバー
コマンド 説明

サーバーの情報を表示する

サーバーを変更する

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

サーバーを削除する

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

## [](#server-groups)ローカルサーバーグループ
コマンド 説明

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

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

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

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

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

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

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

## [](#server-clusters)ローカルクラスターサーバー
コマンド 説明

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

クラスターを削除する

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

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

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

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

クラスターを変更する

## [](#rtf--apps)Runtime Fabric アプリケーション管理
コマンド 説明

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

Exchange アプリケーションを使用して指定された対象にアプリケーションをデプロイし、指定されたランタイムバージョンを実行する

アプリケーションの情報を表示する

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

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

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

デプロイ済みのアプリケーションを修正する

停止中のアプリケーションを開始する

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

仕様のアプリケーションのログを追跡する

## [](#rtf-instances)Runtime Fabric インスタンス
コマンド 説明

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

# Anypoint CLI 4.x コマンドリスト Anypoint Platform CLI で Anypoint Platform の次の機能を管理できます。 [Anypoint Platform アカウント](https://docs.mulesoft.com/jp/anypoint-cli/latest/account) [API カタログ](https://docs.mulesoft.com/jp/anypoint-cli/latest/api-catalog) [API Governance](https://docs.mulesoft.com/jp/anypoint-cli/latest/api-governance) [API Manager](https://docs.mulesoft.com/jp/anypoint-cli/latest/api-mgr) [Cloudhub 2.0](https://docs.mulesoft.com/jp/anypoint-cli/latest/cloudhub2-apps) [Cloudhub アプリケーション](https://docs.mulesoft.com/jp/anypoint-cli/latest/cloudhub-apps) [Cloudhub 専用ロードバランサー](https://docs.mulesoft.com/jp/anypoint-cli/latest/cloudhub-dlb) [Cloudhub Anypoint VPC](https://docs.mulesoft.com/jp/anypoint-cli/latest/cloudhub-vpc) [DataGraph ロードバランサー](https://docs.mulesoft.com/jp/anypoint-cli/latest/datagraph-load-balancer) [Design Center](https://docs.mulesoft.com/jp/anypoint-cli/latest/design-center) [Exchange アセット](https://docs.mulesoft.com/jp/anypoint-cli/latest/exchange-assets) [ハイブリッドアプリケーション](https://docs.mulesoft.com/jp/anypoint-cli/latest/standalone-apps) [ハイブリッドアプリケーションのアラート](https://docs.mulesoft.com/jp/anypoint-cli/latest/standalone-alerts) [ローカルサーバー](https://docs.mulesoft.com/jp/anypoint-cli/latest/servers) [ローカルサーバーグループ](https://docs.mulesoft.com/jp/anypoint-cli/latest/server-groups) [ローカルサーバークラスター](https://docs.mulesoft.com/jp/anypoint-cli/latest/server-clusters) ## [](#anypoint-platform-アカウント)Anypoint Platform アカウント
コマンド 説明

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

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

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

環境をリストする

新しい環境を作成する

環境を削除する

環境の詳細を表示する

## [](#api-カタログ)API カタログ
コマンド 説明

API カタログコマンドのオートコンプリートを設定します。

ログイン情報設定ファイルを作成または削除します。

記述子ファイルを作成します。

記述子ファイルを更新します。

Exchange にアセットをパブリッシュします。

## [](#api-governance)API Governance

コマンド

説明

governance:api:evaluate

検索条件を評価して、その条件を満たす API に適用されるルールセットを決定する

governance:api:inspect

API 仕様を調べ、そのスキーマをリストする

governance:api:validate

指定されたガバナンスルールセットに対して API 仕様を検証する

governance:document

ガバナンスルールセット定義のドキュメントファイルを作成する

governance:profile:create

ガバナンスプロファイルを作成する

governance:profile:delete

ガバナンスプロファイルを削除する

governance:profile:info

特定のガバナンスプロファイル ID の情報をリストする

governance:profile:list

組織内のすべてのガバナンスプロファイルをリストする

governance:profile:update

ガバナンスプロファイルを更新する

governance:ruleset:clone

ガバナンスルールセットをコピーし、指定された更新をルールに適用する

governance:ruleset:info

ルールセットルールをリストする

governance:ruleset:init

データスキーマに基づいてガバナンスルールセット定義を初期化する

governance:ruleset:validate

ガバナンスルールセット定義の形式を検証する

## [](#api-manager)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 層をリストする

## [](#cloudhub-2-0)Cloudhub 2.0
コマンド 説明

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

アプリケーションの情報を表示する

Exchange アプリケーションを使用して指定された対象にアプリケーションをデプロイし、指定されたランタイムバージョンを実行する

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

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

デプロイ済みのアプリケーションを修正する

停止中のアプリケーションを開始する

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

仕様のアプリケーションのログを追跡する

## [](#cloudhub-アプリケーション)Cloudhub アプリケーション
コマンド 説明

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

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

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

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

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

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

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

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

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

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

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

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

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

## [](#cloudhub-専用ロードバランサー)Cloudhub 専用ロードバランサー
コマンド 説明

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

動的 IP を有効にする

動的 IP を無効にする

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

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

## [](#cloudhub-anypoint-vpc)Cloudhub Anypoint VPC
コマンド 説明

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

Anypoint VPC の詳細を表示する

新しい 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 アプリケーションのファイアウォールルールを削除する

## [](#datagraph-ロードバランサー)DataGraph ロードバランサー
コマンド 説明

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

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

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

## [](#design-center)Design Center
コマンド 説明

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

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

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

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

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

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

## [](#exchange-アセット)Exchange アセット
コマンド 説明

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

既存の Exchange アセットの変更可能なデータを変更する

Exchange アセットを変更する

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

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

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

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

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

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

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

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

Exchange アセットをコピーする

Exchange のアセットを削除する

アセットを非推奨にする

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

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

アセットポータルにリソースをアップロードする

アセットポータルでパブリッシュ済みのリソースをリストする

アセットポータルからリソースをダウンロードする

アセットポータルからリソースを削除する

既存アセットの状況を変更する

## [](#ハイブリッドアプリケーション)ハイブリッドアプリケーション
Anypoint Platform CLI で対象サーバーを認識できるように、手動で各サーバーをプラットフォームに登録する必要があります。
コマンド 説明

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

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

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

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

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

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

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

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

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

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

## [](#ハイブリッドアプリケーションのアラート)ハイブリッドアプリケーションのアラート
コマンド 説明

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

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

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

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

## [](#ローカルサーバー)ローカルサーバー
コマンド 説明

サーバーの情報を表示する

サーバーを変更する

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

サーバーを削除する

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

## [](#ローカルサーバーグループ)ローカルサーバーグループ
コマンド 説明

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

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

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

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

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

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

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

## [](#ローカルサーバークラスター)ローカルサーバークラスター
コマンド 説明

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

クラスターを削除する

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

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

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

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

クラスターを変更する

## [](#関連情報)関連情報 - [Anypoint Exchange ドキュメント](https://docs.mulesoft.com/jp/exchange/) - [アクセス管理ドキュメント](https://docs.mulesoft.com/jp/access-management/) - [Anypoint Runtime Manager ドキュメント](https://docs.mulesoft.com/jp/runtime-manager/) - [VPC ドキュメント](https://docs.mulesoft.com/cloudhub/virtual-private-cloud) - [CloudHub ロードバランサードキュメント](https://docs.mulesoft.com/cloudhub/cloudhub-dedicated-load-balancer) - [API Manager 2.x (Crowd リリース) ドキュメント](https://docs.mulesoft.com/jp/api-manager/latest/) - [Design Center ドキュメント](https://docs.mulesoft.com/design-center/) # Anypoint CLI 4.x のインストール コマンドを実行する前に、npm から Anypoint CLI をインストールする必要があります。次のガイドラインに従ってインストールします。 1. [前提条件のソフトウェアをインストールします。](#prereqs)​これは Anypoint CLI のインストールに進む前に行います。 2. [Anypoint CLI 4.x パッケージをインストールします。](#installation)​このパッケージには、すべてのデフォルトのプラグインが含まれます。 3. [デフォルト以外のプラグインまたはデフォルトのプラグインの新しいバージョンをインストールします。](#install-plugins)​これは、Anypoint CLI 4.x のインストール後に必要に応じて行います。 4. [インストールを確認します](#verify-installation)​。 5. 必要に応じて、使用しない​[プラグインをアンインストール](#uninstall-plugin)​するか、使用されなくなったシステムから ​[Anypoint CLI をアンインストールします](#uninstall-anypoint-cli)​。 ## [](#prereqs)始める前に Anypoint CLI は Node.js で構築され、Node JavaScript プラットフォームのパッケージマネージャーである npm を使用してインストールされます。 必要なバージョンは次のとおりです。 - Node.js バージョン 16.0.0 ~ 18.14.0 - npm バージョン 7 以降 前提となるソフトウェアをインストールするには、次の操作を実行します。 - Node.js and npm をダウンロードしてインストールする。 [NodeJS のダウンロードページ](https://nodejs.org/en/download/)​を参照してください。 システムの設定によっては、npm コマンドを正常に実行するには、管理者ログイン情報を使用したログインが必要な場合があります。 ## [](#installation)コアパッケージとデフォルトのプラグインをインストールする 次のコマンドを実行して、Anypoint CLI コアパッケージとすべてのデフォルトのプラグインをインストールします。​[「プラグインのリスト」](#Plugin-list)​を参照してください。 ```text npm install -g anypoint-cli-v4 ``` ## [](#install-plugins)プラグインを個別にインストールする Anypoint CLI 4.x コアパッケージをインストールしたら、デフォルト以外のプラグインまたはデフォルトのプラグインの新しいバージョンを次のようにインストールできます。 ```text anypoint-cli-v4 plugins:install ``` たとえば、アカウントプラグインをインストールするには、次のコマンドを使用します。 ```text anypoint-cli-v4 plugins:install anypoint-cli-account-plugin ``` ### [](#plugin-list)プラグインのリスト Anypoint CLI を使用して次のプラグインをインストールできます。
プラグイン 説明

anypoint-cli-account-plugin

アカウントコマンドのトピック

anypoint-cli-api-mgr-plugin

API Manager コマンドのトピック

anypoint-cli-cloudhub-plugin

CloudHub コマンドのトピック

anypoint-cli-designcenter-plugin

Design Center コマンドのトピック

anypoint-cli-exchange-plugin

Exchange コマンドのトピック

anypoint-cli-governance-plugin

API Governance コマンドのトピック

anypoint-cli-runtime-mgr-plugin

Runtime Manager コマンドのトピック

anypoint-cli-datagraph-plugin

Anypoint DataGraph コマンドのトピック

## [](#verify-installation)インストールの確認 Anypoint CLI をインストールしたら、コマンドを使用して次のようにインストールを確認できます。 - [コアパッケージバージョンを表示する](#view-core-version) - [インストールされたプラグインのリストを表示する](#view-plugin-list) - [すべてのバージョン情報を表示する](#view-all-version-info) ### [](#view-core-version)コアパッケージバージョンを表示する コアパッケージのバージョンを表示するには、次のコマンドを実行します。 ```text anypoint-cli-v4 --version ``` 出力には、インストールされているコアパッケージのバージョンが次のように表示されます。 anypoint-cli-v4/1.x.x node-v16.x.x ### [](#view-plugin-list)インストールされたプラグインのリストを表示する プラグインのインストールを確認し、インストールされたすべてのプラグインのリストを表示するには、次のコマンドを使用します。 ```text anypoint-cli-v4 ``` 出力の ​`TOPICS`​ セクションに、インストールされたプラグインが表示されます。次の例は、アカウントプラグインのみがインストールされていることを示しています。 VERSION anypoint-cli-v4/x.x.x linux-x64 node-v14.17.6 USAGE $ anypoint-cli-v4 \[COMMAND\] TOPICS account Show details of a business group. If "name" is omitted, defaults to the current session's business group plugins list installed plugins COMMANDS conf manage configuration help display help for anypoint-cli plugins list installed plugins ### [](#view-all-version-info)すべてのバージョン情報を表示する インストールされたプラグインのリストと完全なバージョン情報を表示するには、次のコマンドを使用します。 ```text anypoint-cli-v4 plugins --core ``` 出力には、バージョン情報が表示されます。 $ anypoint-cli-v4 plugins --core @oclif/plugin-help 5.1.15 (core) @oclif/plugin-not-found 2.3.4 (core) @oclif/plugin-plugins 2.1.2 (core) @oclif/plugin-version 1.1.3 (core) anypoint-cli-account-plugin 1.0.0 (core) anypoint-cli-api-mgr-plugin 1.0.0 (core) anypoint-cli-cloudhub-plugin 1.0.0 (core) anypoint-cli-command 1.0.1 (core) anypoint-cli-designcenter-plugin 1.0.2 (core) anypoint-cli-exchange-plugin 1.0.0 (core) └─conf-cli 0.1.9 (core) anypoint-cli-runtime-mgr-plugin 1.0.0 (core) anypoint-cli-v4 1.0.2 (core) ## [](#uninstall-plugin)プラグインをアンインストールする たとえば、定期的に使用するものだけに数を減らしたい場合は、プラグインをアンインストールします。 プラグインをアンインストールするには、次のコマンドを実行します。 ```text anypoint-cli-v4 plugins:uninstall anypoint-cli--plugin ``` たとえば、次のコマンドはアカウントプラグインをアンインストールします。 ```text anypoint-cli-v4 plugins:uninstall anypoint-cli-account-plugin ``` [「プラグインのリスト」](#Plugin-list)​を参照してください。 ## [](#uninstall-anypoint-cli)Anypoint CLI をアンインストールする Anypoint CLI が使用されなくなったシステムから、Anypoint CLI をアンインストールすることをお勧めします。 Anypoint CLI をアンインストールするには、次のコマンドを実行します。 ```text npm uninstall -g anypoint-cli-v4 ``` # Anypoint CLI の使用 Anypoint Platform CLI コールの形式は、次のようになります。 ```console $ anypoint-cli [params] [command] ``` ## [](#exit)exit \> exit \[options\] このコマンドは、Anypoint Platform CLI を終了します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 コマンドを渡さない場合、Anypoint Platform CLI は対話型モードで実行されます。 特定のコマンドを渡してエラーがあると、アプリケーションが終了して問題の説明が返されます。 Anypoint Platform CLI には、3 つのデフォルトオプションがあります。 - `--help`​ オプション。コマンドの利用方法の情報を表示します。 - `-o`​ または ​`--output`​ オプション。コマンドの出力を定義済みの形式に指定できます。 サポートされている値は、​`table`​、​`text`​、​`json`​ です。非対話型モードのデフォルトは ​`text`​、対話型セッションのデフォルトは ​`table`​ です。 - `-f`​ または ​`--fields`​ オプション。出力する項目を定義できます。 コマンドの後に ​`--fields`​ オプションを渡して、出力可能なすべての項目のリストを取得できます。 # Anypoint DataGraph の CLI Anypoint CLI では次の DataGraph 機能の管理がサポートされます。 - [DataGraph API ソース管理](https://docs.mulesoft.com/jp/anypoint-cli/3.x/datagraph-source) - [DataGraph ロードバランサー](https://docs.mulesoft.com/jp/anypoint-cli/3.x/datagraph-load-balancer) # Anypoint Platform CLI 4.x の使用開始 Anypoint Platform CLI は、Anypoint Platform と Anypoint Platform Private Cloud Edition (Anypoint Platform PCE) のスクリプトおよびコマンドラインツールです。
Anypoint Platform CLI 4.x には後方互換性がありません。Anypoint CLI 4.x より前のバージョンの Anypoint CLI を使用している場合は、​最初にこちらで違いを確認​してください。
Anypoint CLI の使用を開始する手順は、次のとおりです。 1. [Anypoint CLI 4.x のインストール](https://docs.mulesoft.com/jp/anypoint-cli/latest/install)​ Anypoint CLI をインストールします。 2. [コマンドの一般的な使用方法を学びます](https://docs.mulesoft.com/jp/anypoint-cli/latest/intro)​ (認証方法や、必要に応じてプロキシを使用する方法など)。 3. [コマンドのリストを表示します。](https://docs.mulesoft.com/jp/anypoint-cli/latest/anypoint-platform-cli-commands)​このリストは、Anypoint CLI を使用して実行可能な Anypoint Platform アクションで使用できるコマンドのリストです。 4. [Anypoint Platform に対する認証](https://docs.mulesoft.com/jp/anypoint-cli/latest/auth)​を行います。 5. [プロキシサーバーを使用](https://docs.mulesoft.com/jp/anypoint-cli/latest/proxy)​します。 # Anypoint Platform CLI に対する認証 Anypoint CLI に対して認証するには、認証オプションの組み合わせのいずれかを使用する必要があります。 - ユーザー名とパスワード - クライアント ID とクライアントシークレット - ベアラートークン (コマンドラインのみ)
2022 年 10 月以降、すべてのユーザーに対する多要素認証 (MFA) の有効化の一環として、Anypoint CLI を使用する方法は​接続アプリケーション​経由のみになります。
指定しない場合、デフォルトのホスト、環境、および組織が使用されます。 次の方法を使用して、Anypoint CLI ログイン情報を渡します。 - [ログイン情報設定ファイルの使用](#credentials-file) - [コマンドラインパラメーターの使用](#command-line-parameters) - [環境変数の使用](#env-variables) 設定は次のように上書きされます。 - コマンドラインパラメーターはその他すべての方法を上書きする。 - コマンドラインパラメーターが指定されていない場合は環境変数が使用され、ログイン情報設定ファイルの設定を上書きする。 - コマンドラインパラメーターまたは環境変数が設定されていない場合、ログイン情報設定ファイルのパラメーターが使用される。 ## [](#credentials-file)Conf コマンドを使用してログイン情報を設定する `conf`​ オプションを指定して ​`anypoint-cli-v4`​ コマンドを実行し、ログイン情報を設定ファイルに追加してから、使用する ​`anypoint-cli-v4`​ コマンドを実行することで、Anypoint Platform に対して認証できます。次のパラメーターの組み合わせを使用して、設定ファイルに認証値を設定できます。 username password client\_id client\_secret host session.selectedEnvironment.id session.selectedOrganization.id 設定ファイルを作成するには、次の操作を実行します。 - 認証方法の設定に使用するパラメーターを指定して、​`anypoint-cli-v4 conf`​ コマンドを実行する。たとえば、次のコマンドはユーザー名とパスワードを設定します。 $ anypoint-cli-v4 conf username $ anypoint-cli-v4 conf password このコマンドは、次の場所にある ​`config.json`​ ファイルにログイン情報を保存します。 - MacOS: `~/Library/Preferences/@mulesoft/anypoint-cli-v4-nodejs/config.json` - Windows: `%APPDATA%\anypoint-cli-v4-nodejs\Config` - Unix: `~/.config/anypoint-cli-v4-nodejs/` **例:** - ユーザー名とパスワードを使用して設定ファイル認証を設定する - 次のコマンドを使用して、設定ファイルに認証値を追加します。 $ anypoint-cli-v4 conf username myUserName $ anypoint-cli-v4 conf password myPassword $ anypoint-cli-v4 conf organization myOrgId - コマンドを実行すると、設定ファイルの値を使用して認証が行われます。 $ anypoint-cli-v4 account:environment:list - クライアント ID とクライアントシークレットを使用して設定ファイル認証を設定する - 次のコマンドを使用して、設定ファイルに認証値を追加します。 $ anypoint-cli-v4 conf client\_id myClientID $ anypoint-cli-v4 conf client\_secret myCLientSecret $ anypoint-cli-v4 conf organization myOrgId - コマンドを実行すると、設定ファイルの値を使用して認証が行われます。 $ anypoint-cli-v4 account:environment:list `organization`​ フラグは省略可能です。デフォルトでは、Anypoint Platform のメイン組織に設定されます。

client_id​ と ​client_secret​ は接続アプリケーション経由で取得できます。詳細は、​「開発者向けの接続アプリケーション」​を参照してください。

接続アプリケーションでは、Anypoint Platform に対する認証を行うために ​[View Organization (組織の表示)]​ スコープと ​[View Environment (環境の表示)]​ スコープが必要です。

## [](#command-line-parameters)コマンドラインパラメーター 次のパラメーターの組み合わせを使用して ​`anypoint-cli-v4`​ コマンドを実行することで、コマンドラインから Anypoint Platform に対して認証できます。 \--username --password --client\_id --client\_secret --bearer --organization --environment
--organization​ フラグは省略可能です。デフォルトでは、Anypoint Platform のメイン組織に設定されます。 例:
- ユーザー名とパスワードを使用してコマンドラインで認証する $ anypoint-cli-v4 account:environment:list --username myUserName --password myPassword --organization myOrgId - クライアント ID とクライアントシークレットを使用してコマンドラインで認証する $ anypoint-cli-v4 account:environment:list --client\_id myClientID --client\_secret myClientSecret --organization myOrgId - ベアラートークンを使用してコマンドラインで認証する Anypoint Platform でベアラートークンを生成し、Anypoint CLI に直接渡すことができます。ベアラートークンを提供した場合、Anypoint CLI は他に提供されているすべてのユーザーログイン情報やクライアントログイン情報を無視します。 $ anypoint-cli-v4 account:environment:list --bearer myBearerToken --organization myOrgId ベアラートークンの有効期限が切れると、Anypoint Platform セッションの有効期限が切れます。 ベアラートークンの生成については、 [「How to Generate Your Authorization Bearer Token for Anypoint Platform (Anypoint Platform 用の認証ベアラートークンの生成方法)」](https://help.mulesoft.com/s/article/How-to-generate-your-Authorization-Bearer-token-for-Anypoint-Platform)​を参照してください。 ## [](#env-variables)環境変数 `anypoint-cli-v4`​ コマンドを実行する前に、次の環境変数の組み合わせを設定することで、Anypoint Platform に対して認証できます。 ANYPOINT\_USERNAME ANYPOINT\_PASSWORD ANYPOINT\_CLIENT\_ID ANYPOINT\_CLIENT\_SECRET ANYPOINT\_ORG ANYPOINT\_ENV ANYPOINT\_HOST ANYPOINT\_CERTIFICATE **例:** - ユーザー名とパスワードの環境変数を設定して認証する $ export ANYPOINT\_USERNAME=myUserName $ export ANYPOINT\_PASSWORD=myPassword $ export ANYPOINT\_ORG=myOrgId $ anypoint-cli-v4 account:environment:list - クライアント ID とクライアントシークレットの環境変数を設定して認証する $ export ANYPOINT\_CLIENT\_ID=myClientID $ export ANYPOINT\_CLIENT\_SECRET=myCLientSecret $ export ANYPOINT\_ORG=myOrgId $ anypoint-cli-v4 account:environment:list # Anypoint Platform アカウントの CLI
コマンド 説明

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

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

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

環境をリストする

新しい環境を作成する

環境を削除する

環境の詳細を表示する

## [](#account-user-describe)account user describe \> account user describe \[options\] このコマンドは、アカウントの情報を返します。これには、ユーザー名、氏名、メールアドレス、アカウントの作成日が含まれます。 このコマンドでは、デフォルトのオプション (​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​) 以外のオプションは使用できません。 ## [](#account-business-group-list)account business-group list \> account business-group list \[options\] このコマンドは、すべての​[ビジネスグループ](https://docs.mulesoft.com/jp/access-management/business-groups)​をリストします。ビジネスグループの名前、種別 (「Master」または「Business unit」)、ID を返します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#account-business-group-describe)account business-group describe \> account business-group describe \[options\] このコマンドは、​``​ で渡すビジネスグループに関する情報を表示します。 ``​ が指定されていない場合、このコマンドは現在のセッションのビジネスグループの情報を表示します。 識別子は、最初に ID の一致を検索し、次に名前を検索します。

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

> account business-group describe "QA Organization"
このコマンドは、オーナー、種別、サブスクリプション情報、グループのエンタイトルメント、実行環境などのデータを返します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#account-environment-list)account environment list \> account environment list \[options\] このコマンドは、Anypoint Platform のすべての環境をリストします。環境名、ID、および Sandbox 環境かどうかどうかを返します。 このコマンドでは、デフォルトのオプション (​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​) 以外のオプションは使用できません。 ## [](#account-environment-create)account environment create \> account environment create \[options\] このコマンドは、​``​ で設定した名前を使用して新しい環境を作成します。 このコマンドでは、デフォルトの ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ オプション以外に ​`--type`​ オプションも使用できます。​`--type`​ オプションを使用して、環境種別を指定します。 環境種別では、次の値がサポートされています。 - `design` - `production` - `sandbox` 種別が指定されていない場合、このコマンドは本番環境を作成します。 ## [](#account-environment-delete)account environment delete \> account environment delete \[options\] このコマンドは、​``​ で指定される環境を削除します。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#account-environment-describe)account environment describe \> account environment describe \[options\] このコマンドは、​``​ で指定される環境に関する情報を返します。 ``​ が指定されていない場合、このコマンドは現在のセッションの環境に関する情報を返します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 # Anypoint Platform アカウントの CLI
コマンド 説明

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

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

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

環境をリストする

新しい環境を作成する

環境を削除する

環境の詳細を表示する

## [](#account-user-describe)account:user:describe \> account:user:describe \[flags\] ユーザー名、氏名、メールアドレス、アカウントの作成日などのアカウント情報を返します。 `--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 このコマンドでは、デフォルトのフラグ ​`--help`​ を受け入れます。 ## [](#account-business-group-list)account:business-group:list \> account:business-group:list \[flags\] すべての​[ビジネスグループ](https://docs.mulesoft.com/jp/access-management/business-groups)​を表示します。ビジネスグループの名前、種別 (「Master」または「Business unit」)、ID を返します。 `--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 このコマンドでは、デフォルトのフラグ ​`--help`​ を受け入れます。 ## [](#account-business-group-describe)account:business-group:describe \> account:business-group:describe \[flags\] このコマンドは、​``​ で渡すビジネスグループに関する情報を表示します。 ``​ が指定されていない場合、このコマンドは現在のセッションのビジネスグループの情報を表示します。 識別子は、最初に ID の一致を検索し、次に名前を検索します。

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

> account:business-group:describe "QA Organization"
ビジネスグループオーナー、種別、サブスクリプション情報、グループのエンタイトルメント、実行環境を返します。 `--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 このコマンドでは、デフォルトのフラグ ​`--help`​ を受け入れます。 ## [](#account-environment-list)account:environment:list \> account:environment:list \[flags\] このコマンドは、Anypoint Platform のすべての環境をリストします。環境名、ID、および Sandbox 環境かどうかどうかを返します。 `--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 このコマンドでは、デフォルトのフラグ ​`--help`​ を受け入れます。 ## [](#account-environment-create)account:environment:create \> account:environment:create \[flags\] このコマンドは、​``​ で設定した名前を使用して新しい環境を作成します。 ​`--type`​ フラグを使用して、環境種別を指定します。 環境種別では、次の値がサポートされています。 - `design` - `production` - `sandbox` 種別が指定されていない場合、このコマンドは Sandbox 環境を作成します。 `--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 このコマンドでは、デフォルトのフラグ ​`--help`​ を受け入れます。 ## [](#account-environment-delete)account:environment:delete \> account:environment:delete \[flags\] このコマンドは、​``​ で指定される環境を削除します。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#account-environment-describe)account:environment:describe \> account:environment:describe \[flags\] このコマンドは、​``​ で指定される環境に関する情報を返します。 ``​ が指定されていない場合、このコマンドは現在のセッションの環境に関する情報を返します。 `--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 このコマンドでは、デフォルトのフラグ ​`--help`​ を受け入れます。 # Anypoint Runtime Fabric の CLI Anypoint CLI では次の Runtime Fabric 機能の管理がサポートされます。 - [Runtime Fabric アプリケーション管理](https://docs.mulesoft.com/jp/anypoint-cli/3.x/runtime-fabric-apps) - [Runtime Fabric インスタンス](https://docs.mulesoft.com/jp/anypoint-cli/3.x/rtf-instances) # Anypoint Virtual Private Cloud の CLI
コマンド 説明

すべての 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 アプリケーションのファイアウォールルールを削除する

## [](#cloudhub-vpc-list)cloudhub vpc list \> cloudhub VPC list \[options\] このコマンドは、使用可能なすべての Anypoint VPC をリストします。ID、リージョン、ネットワークの環境、およびデフォルトの Anypoint VPC かどうかを返します。 ## [](#cloudhub-vpc-describe)cloudhub vpc describe \> cloudhub vpc describe \[options\] このコマンドは、​``​ で指定される Anypoint VPC に関する情報を表示します。 Anypoint VPC の名前の入力を開始して ​`tab`​ キーを押すと、Anypoint Platform CLI によって名前がオートコンプリートされます。また、​`tab`​ キーをダブルタップすると、渡すことができるすべての値の完全なリストが表示されます。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#cloudhub-vpc-describe-json)cloudhub vpc describe-json \> cloudhub vpc describe \[options\] このコマンドは、​``​ で指定される Anypoint VPC の未加工の JSON 応答を表示します。 Anypoint VPC の名前の入力を開始して ​`tab`​ キーを押すと、Anypoint Platform CLI によって名前がオートコンプリートされます。また、​`tab`​ キーをダブルタップすると、渡すことができるすべての値の完全なリストが表示されます。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#cloudhub-vpc-create)cloudhub vpc create \> cloudhub vpc create \[options\] \[environments...\] このコマンドは、クラスレスインタードメインルーティング (CIDR) ブロック形式 ( [CIDR 表記](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#IPv4_CIDR_blocks)​を使用) の ​``​ で渡される​[サイズ](https://docs.mulesoft.com/cloudhub/vpc-provisioning-concept#faq_how_to_size_vpc)​で ​``​ の名前を使用して ​``​ で指定されるリージョンに Anypoint VPC を作成し、後で引数として渡される​[環境](https://docs.mulesoft.com/jp/access-management/environments)​に関連付けます。
Anypoint VPC は、組織内のビジネスグループにバインドされている必要があります。Anypoint VPC を作成するときに ​business-groups add​ コマンドを使用して、ビジネスグループに割り当ててください。
このコマンドでは、デフォルトの ​`--help`​ オプション以外に ​`--default`​ オプションも使用できます。渡されると、Anypoint VPC は選択された環境のデフォルトの Anypoint VPC として作成されます。 ## [](#cloudhub-vpc-delete)cloudhub vpc delete \> cloudhub vpc delete このコマンドは、​``​ で指定される Anypoint VPC を削除します。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#cloudhub-vpc-environments-add)cloudhub vpc environments add \> cloudhub vpc environments add \[options\] \[environments...\] このコマンドは、​``​ で定義される Anypoint VPC を、後で引数として渡される環境に割り当てます。 `--default`​ オプションでは、Anypoint VPC を組織のデフォルトとして設定できます。これは、Anypoint VPC が明示的に関連付けられていないすべての環境に適用されます。 このコマンドでは、デフォルトの ​`--help`​ オプションも使用できます。 ## [](#cloudhub-vpc-environments-remove)cloudhub vpc environments remove \> cloudhub vpc environments remove \[options\] \[environments...\] このコマンドは、​``​ で定義される Anypoint VPC を、後で引数として渡される環境から削除します。 このコマンドでは、デフォルトの ​`--help`​ オプション以外に、この Anypoint VPC を環境のデフォルトの Anypoint VPC として削除する ​`--default`​ オプションも使用できます。 ## [](#cloudhub-vpc-business-groups-add)cloudhub vpc business-groups add \> cloudhub vpc business-groups add \[options\] このコマンドは、​``​ で定義される Anypoint VPC を、後で引数として渡されるビジネスグループに割り当てます。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#cloudhub-vpc-business-groups-remove)cloudhub vpc business-groups remove \> cloudhub vpc business-groups remove \[options\] このコマンドは、​``​ で定義される Anypoint VPC を、後で引数として渡されるビジネスグループから削除します。
このコマンドは、指定されたリソースから Anypoint VPC を削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#cloudhub-vpc-dns-servers-set)cloudhub vpc dns-servers set \> cloudhub vpc dns-servers set \[options\] このコマンドは、非公開アドレスでも公開アドレスでも 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 `​。 このコマンドを実行するたびに、以前の DNS セットコマンドは上書きされます。 DNS セットを削除するには、​[vpc dns-servers unset](#cloudhub-vpc-dns-servers-unset)​ コマンドを使用する必要があります。 ## [](#cloudhub-vpc-dns-servers-unset)cloudhub vpc dns-servers unset \> cloudhub vpc dns-servers unset \[options\] このコマンドは、​``​ で渡される Anypoint VPC の DNS サーバーを使用して解決されるローカルホスト名 (内部ドメイン名) のリストをクリアします。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#cloudhub-vpc-firewall-rules-describe)cloudhub vpc firewall-rules describe \> cloudhub vpc firewall-rules describe このコマンドは、​``​ で定義される Anypoint VPC のすべてのファイアウォールルールの情報を表示します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#cloudhub-vpc-firewall-rules-add)cloudhub vpc firewall-rules add \> cloudhub vpc firewall-rules add \[options\] \[toPort\] このコマンドは、変数で設定される値を使用して、​``​ で定義される 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 \> cloudhub vpc firewall-rules remove このコマンドは、​``​ で渡されるインデックスで、​``​ で指定される Anypoint VPC 内のワーカーからファイアウォールルールを削除します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 # Anypoint Virtual Private Cloud の CLI
コマンド 説明

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

Anypoint VPC の詳細を表示する

新しい 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 アプリケーションのファイアウォールルールを削除する

## [](#cloudhub-vpc-list)cloudhub:vpc:list \> cloudhub:vpc:list \[flags\] このコマンドは、使用可能なすべての Anypoint VPC をリストします。ID、リージョン、ネットワークの環境、およびデフォルトの Anypoint VPC かどうかを返します。 このコマンドには ​`--output`​ フラグを使用できます。​`--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 ## [](#cloudhub-vpc-describe)cloudhub:vpc:describe \> cloudhub:vpc:describe \[flags\] このコマンドは、​``​ で指定される Anypoint VPC に関する情報を表示します。 フラグ ​`-o json`​ を使用して、​``​ で指定するアプリケーションの未加工の JSON 応答を取得します。 このコマンドには ​`--output`​ フラグを使用できます。​`--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#cloudhub-vpc-create)cloudhub:vpc:create \> cloudhub:vpc:create \[flags\] \[environments...\] このコマンドは、クラスレスインタードメインルーティング (CIDR) ブロック形式 ( [CIDR 表記](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#IPv4_CIDR_blocks)​を使用) の ​``​ で渡される​[サイズ](https://docs.mulesoft.com/cloudhub/vpc-provisioning-concept#faq_how_to_size_vpc)​で ​``​ の名前を使用して ​``​ で指定されるリージョンに Anypoint VPC を作成し、後で引数として渡される​[環境](https://docs.mulesoft.com/jp/access-management/environments)​に関連付けます。
Anypoint VPC は、組織内のビジネスグループにバインドされている必要があります。Anypoint VPC を作成するときに ​business-groups add​ コマンドを使用して、ビジネスグループに割り当ててください。
このコマンドでは、デフォルトの ​`--help`​ フラグ以外に ​`--default`​ フラグも使用できます。渡されると、Anypoint VPC は選択された環境のデフォルトの Anypoint VPC として作成されます。 このコマンドには ​`--output`​ フラグを使用できます。​`--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 ## [](#cloudhub-vpc-delete)cloudhub:vpc:delete \> cloudhub:vpc:delete このコマンドは、​``​ で指定される Anypoint VPC を削除します。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#cloudhub-vpc-environments-add)cloudhub:vpc:environments:add \> cloudhub:vpc:environments:add \[flags\] \[environments...\] このコマンドは、​``​ で定義される Anypoint VPC を、後で引数として渡される環境に割り当てます。 `--default`​ フラグでは、Anypoint VPC を組織のデフォルトとして設定できます。これは、Anypoint VPC が明示的に関連付けられていないすべての環境に適用されます。 このコマンドでは、デフォルトの ​`--help`​ フラグも使用できます。 ## [](#cloudhub-vpc-environments-remove)cloudhub:vpc:environments:remove \> cloudhub:vpc:environments:remove \[flag\] \[environments...\] このコマンドは、​``​ で定義される Anypoint VPC を、後で引数として渡される環境から削除します。 このコマンドでは、デフォルトの ​`--help`​ フラグ以外に、この Anypoint VPC を環境のデフォルトの Anypoint VPC として削除する ​`--default`​ フラグも使用できます。 ## [](#cloudhub-vpc-business-groups-add)cloudhub:vpc:business-groups:add \> cloudhub:vpc:business-groups:add \[flags\] このコマンドは、​``​ で定義される Anypoint VPC を、後で引数として渡されるビジネスグループに割り当てます。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#cloudhub-vpc-business-groups-remove)cloudhub:vpc:business-groups:remove \> cloudhub:vpc:business-groups:remove \[flags\] このコマンドは、​``​ で定義される Anypoint VPC を、後で引数として渡されるビジネスグループから削除します。
このコマンドは、指定されたリソースから Anypoint VPC を削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#cloudhub-vpc-dns-servers-set)cloudhub:vpc:dns-servers:set \> cloudhub:vpc:dns-servers:set \[flags\] このコマンドは、非公開アドレスでも公開アドレスでも IP アドレスを指定する必要がある DNS サーバーを使用して解決されるローカルホスト名 (内部ドメイン名) のリストを設定します。 それらの非公開ドメインが指定されている場合、ワーカーは非公開 DNS を使用して解決するため、非公開ネットワークの内部ホスト名を引き続き使用できます。
この機能は、Mule バージョン 3.5.x、3.6.x、3.7.4、3.8.0-HF1、3.8.1、3.8.2 を実行しているワーカーでサポートされます。
このコマンドでは、デフォルトの ​`--help`​ フラグ以外に次のフラグも受け入れます。
フラグ 説明

--server

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

--domain

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

ドメインは任意の数、IP アドレスは最大 3 個渡すことができます。 例: `$ cloudhub:vpc:dns-servers:set --domain example.com --server 192.168.1.10 `​. このコマンドを実行するたびに、以前の DNS セットコマンドは上書きされます。 DNS セットを削除するには、​[vpc dns-servers unset](#cloudhub-vpc-dns-servers-unset)​ コマンドを使用する必要があります。 ## [](#cloudhub-vpc-dns-servers-unset)cloudhub:vpc:dns-servers:unset \> cloudhub:vpc:dns-servers:unset \[flags\] このコマンドは、​``​ で渡される Anypoint VPC の DNS サーバーを使用して解決されるローカルホスト名 (内部ドメイン名) のリストをクリアします。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#cloudhub-vpc-firewall-rules-describe)cloudhub:vpc:firewall-rules:describe \> cloudhub:vpc:firewall-rules:describe このコマンドは、​``​ で定義される Anypoint VPC のすべてのファイアウォールルールの情報を表示します。 このコマンドには ​`--output`​ フラグを使用できます。​`--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 このコマンドでは、デフォルトのフラグ ​`--help`​ も受け入れます。 ## [](#cloudhub-vpc-firewall-rules-add)cloudhub:vpc:firewall-rules:add \> cloudhub:vpc:firewall-rules:add \[flags\] \[toPort\] このコマンドは、変数で設定される値を使用して、​``​ で定義される 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 アドレスまたはアドレスの範囲を承認する必要があります。

このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#cloudhub-vpc-firewall-rules-remove)cloudhub:vpc:firewall-rules:remove \> cloudhub:vpc:firewall-rules:remove このコマンドは、​``​ で渡されるインデックスで、​``​ で指定される Anypoint VPC 内のワーカーからファイアウォールルールを削除します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 # API Catalog (API カタログ)
コマンド 説明

API カタログコマンドのオートコンプリートを設定します。

ログイン情報設定ファイルを作成または削除します。

記述子ファイルを作成します。

記述子ファイルを更新します。

Exchange にアセットをパブリッシュします。

## [](#autocomplete-command)api-catalog autocomplete $ api-catalog autocomplete \[flags\] このコマンドは、次のフラグを受け入れます。
フラグ 説明

blank

オートコンプリートの設定手順を表示します。

bash

Bash シェル設定を使用してオートコンプリートをインストールします。

zsh

Z シェル設定を使用してオートコンプリートをインストールします。

-r, --refresh cache

現在のオートコンプリート設定を削除します。これは、別のシェル種別でコマンドを実行する前に使用します。

**例** $ api-catalog autocomplete $ api-catalog autocomplete bash $ api-catalog autocomplete zsh $ api-catalog autocomplete --refresh-cache
現時点では、API Catalog CLI オートコンプリートプラグインは、Windows ではサポートされていません。
## [](#conf-command)api-catalog conf キーと値のペアを追加および削除して、設定ファイル (config.json) で認証ログイン情報を管理します。コマンドの実行ごとに 1 つのキーと値のペアを設定します。 \> api-catalog conf \[flags\] `` 認証キー名。使用可能なキー名: username password client\_id client\_secret host environment organization `` 指定された認証キーの値。 このコマンドは、次のフラグを受け入れます。
フラグ 説明

-d, ​--delete

指定されたキーの設定ファイルエントリを削除します。

-h, ​--help

コマンドのヘルプを表示します。

-k, ​--key=key

指定されたキーに対応する値を表示します。

-v, ​--value=value

指定された値に対応するキーを表示します。

## [](#create-descriptor-command)api-catalog create-descriptor \> api-catalog create-descriptor \[flags\] このコマンドは、次のフラグを受け入れます。
フラグ 説明

-d, ​--file=file

デフォルト: catalog.yaml​

生成されたカタログ記述子ファイルを保存する名前と場所。

--external

記述子ファイルに記述されている API ごとに ​exchange.json​ ファイルを生成し、​projects​ セクションの ​ref​ タグを使用して記述子ファイル内の各 API への参照を追加します。

## [](#update-descriptor-command)api-catalog update-descriptor \> api-catalog update-descriptor \[flags\] このコマンドは、次のフラグを受け入れます。
フラグ 説明

-d, ​--descriptor-file=descriptor-file

デフォルト: catalog.yaml​

更新されたカタログ記述子ファイル情報を保存する名前と場所。

## [](#publish-asset-command)api-catalog publish-asset \> api-catalog publish-asset \[flags\] このコマンドは、次のフラグに加えて、​[一般フラグと認証フラグ](https://docs.mulesoft.com/jp/exchange/apicat-use-api-catalog-cli#common-options)​を受け入れます。
フラグ 説明

--async

パブリッシュジョブを非同期で実行します。

-d, ​--descriptor-file=descriptor-file

または

ANYPOINT_DESCRIPTOR_FILE​ 環境変数

デフォルト: ./catalog.yaml

カタログ記述子ファイルの名前と場所。

  • ファイルが存在しない場合、アセットはカタログ化されません。

  • ファイルが存在しても空の場合、このコマンドはカタログ記述子 YAML の結果を作成して出力します。現在の作業ディレクトリに関連する完全なディレクトリツリーで見つかったすべての API 定義のカタログ情報を出力します。

  • 有効な YAML ファイルが存在する場合、このコマンドはアセットを指定されたとおりにカタログ化します。

​「CLI を使用した記述子ファイルの作成」​を参照してください。

--dry-run

コマンドを実行して、記述子ファイルが有効であることを確認します。API はパブリッシュされません。

--force-publish

比較せずに、コンテンツに関係なく Exchange に新しいバージョンのアセットを作成します。

--force-update-metadata

コンテンツに関係なく、タグなどのアセットのメタデータを Exchange の最新バージョンに更新します。アセットは再パブリッシュされません。

--json

実行結果を JSON 形式で出力します。

-s, ​--silent

サイレントログを有効にします。

-t, ​--trigger-criteria=<descriptor-tag>:<value> ​--trigger-criteria=<descriptor-tag>:value

このフラグは、記述子ファイルの ​triggerConditions​ セクションと連携して機能します。​api-catalog publish-asset​ コマンドを実行するたびに、トリガー値が記述子ファイルのトリガー条件値と比較され、記述子ファイルに記述されている API をパブリッシュするかどうかが決定されます。複数の条件と照合するには、条件ごとに個別の ​--trigger-criteria​ フラグを指定します。API をパブリッシュするには、記述子ファイルに設定されたすべてのトリガー条件が ​--trigger-criteria​ フラグ値で照合される必要があります。

例:

--trigger-criteria=branch:main --trigger-criteria=anytag:release/ --trigger=user:admin

「記述子 YAML スキーマ」​を参照してください。

-v, ​--verbose

冗長ログを有効にします。

--version-strategy-criteria=<descriptor-tag>:<value>

このフラグは、記述子ファイルの ​versionStrategyConditions​ セクションと連携して機能します。​api-catalog publish-asset​ コマンドは、バージョン戦略条件値を記述子ファイル内のバージョン戦略条件値と比較して、API のパブリッシュに使用するバージョン戦略を決定します。複数の条件と照合するには、条件ごとに個別の ​--version-strategy-criteria​ フラグを指定します。

例:

--version-strategy-criteria=branch:main --version-strategy-criteria=anytag:release/ --version-strategy-criteria=user:admin

「記述子 YAML スキーマ」​を参照してください。

## [](#common-options)一般フラグと認証フラグ Anypoint Platform に対して認証するコマンドの一般フラグと認証フラグを次に示します。
フラグ 説明

--client_id=client_id​

または

ANYPOINT_CLIENT_ID​ 環境変数

接続アプリケーションクライアント ID。

「認証」​を参照してください。

--client_secret​

または

ANYPOINT_CLIENT_SECRET​ 環境変数

クライアント ID の接続アプリケーションシークレットのプロンプト。

​「認証」​を参照してください。

--collectMetrics​

または

COLLECT_METRICS​ 環境変数

現在使用されていません。

--environment=environment​

または

ANYPOINT_ENV​ 環境変数

API がカタログ化されている Anypoint Platform 環境の名前。

--host=host

または

ANYPOINT_HOST​ 環境変数

デフォルト:

anypoint.mulesoft.com

プロトコルなしの Anypoint Platform ベース URL。

US Anypoint Platform の場合、次を使用します。

anypoint.mulesoft.com

ヨーロッパの Anypoint Platform の場合、次を使用します。

eu1.anypoint.mulesoft.com

--organization=organization​

または

ANYPOINT_ORG​ 環境変数

API がカタログ化されている Anypoint Platform 組織の ID。

-p, ​--password​

または

ANYPOINT_PASSWORD​ 環境変数

Anypoint ユーザーパスワード。

​「認証」​を参照してください。

-u, ​--username=username​

または

ANYPOINT_USERNAME​ 環境変数

Anypoint ユーザー名。

「認証」​を参照してください。

# API Governance の CLI

コマンド

説明

governance api evaluate

検索条件を評価して、その条件を満たす API に適用されるルールセットを決定する

governance api inspect

API 定義を調べ、そのスキーマをリストする

governance api validate

指定されたガバナンスルールセットに対して API 定義を検証する

governance document

ガバナンスルールセット定義のドキュメントファイルを作成する

governance profile create

ガバナンスプロファイルを作成する

governance profile delete

ガバナンスプロファイルを削除する

governance profile info

特定のガバナンスプロファイル ID の情報をリストする

governance profile list

組織内のすべてのガバナンスプロファイルをリストする

governance profile update

ガバナンスプロファイルを更新する

governance ruleset clone

ガバナンスルールセットをコピーし、指定された更新をルールに適用する

governance ruleset info

ルールセットルールをリストする

governance ruleset init

データスキーマに基づいてガバナンスルールセット定義を初期化する

governance ruleset validate

ガバナンスルールセット定義の形式を検証する

## [](#governance-api-evaluate)governance api evaluate `> governance api evaluate [options]` このコマンドは、指定された検索条件を評価して、その条件を満たす API に適用されるルールセットを決定します。 このコマンドでは、デフォルトの ​`--help`​、​`-f/--fields`​、​`-o/--output`​ オプション以外に次のオプションも使用できます。
オプション 説明

--api=<api>

評価する API プロジェクト。このコマンドは、プロジェクトの ​exchange.json​ ファイルの条件を使用します。

--criteria <filtertype:filtervalue>,…​

ルールセットを識別するために評価する検索条件を適用できます。カンマ区切りの検索条件のリストを指定します。各検索条件の種別と値は、​filtertype:filtervalue​ の形式です。

次のような検索条件を使用できます。

  • scope​: API 種別、​rest-api​ または ​async-api​

  • tag​: Exchange で API に対して定義されたタグ

  • category​: Exchange で API に対して定義されたカテゴリ。検索条件値は ​categoryName:value​ として 2 つの部分で指定されます。

  • status​: ライフサイクル状態 (安定、開発、または非推奨)

  • env-type​: 環境種別 (すべて、本番、または Sandbox)

  • env-id​: API Manager の環境名の ID。​[API Manager]​ > ​[Environment information (環境情報)]​ を使用してこの値を取得できます。​「環境の概念の確認」​を参照してください。

    env-type​ または ​env-id​ が使用されている場合、プロファイルに ​[API Instance (API インスタンス)]​ 検索条件が設定されるため、インスタンスが設定された API のみが絞り込まれます。開発ライフサイクルの API にはインスタンスを設定できません。

    CLI を使用してプロファイルの ​[API Instance (API インスタンス)]​ を選択解除するには、​env-type​ も ​env-id​ も含まれない ​--criteria​ フラグを使用してプロファイルを更新します。

例: tag:tag1,category:category1:value,category:category2:value2,status:stable,status:development,status:deprecated,scope:rest-api,scope:async-api,env-type:production

このコマンドは、​criteria​ または ​api​ オプションを使用して実行する必要があります。
**コマンド例:** ```copy anypoint-cli governance api evaluate --criteria `tag:best,category:API Type:Experience API,scope:rest-api` anypoint-cli governance api evaluate --api ~/Downloads/order-api-1.0.0-raml.zip ``` **出力例:** Ruleset GAV 68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-best-practices/1.0.0 8a840abd-e63a-4f8b-87ab-24052eda2017/best-practices-ruleset/1.0.0 68ef9520-24e9-4cf2-b2f5-620025690913/required-examples/1.0.0 ## [](#governance-api-inspect)governance api inspect `> governance api inspect [options] ` このコマンドは、​`api-definition`​ で渡された API 定義を調べ、ヘッダー、要求、応答ペイロードなどのすべてのスキーマをリストします。このスキーマ情報は、​`governance ruleset init`​ コマンドで使用できます。​[governance ruleset init](#governance-ruleset-init)​を参照してください。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 **コマンド例:** ```copy anypoint-cli governance api inspect my-healthcare-api.yaml ``` **スキーマの例** ```copy types: patientmultipleBirthBoolean: properties: multipleBirthBoolean: description: Whether patient is part of a multiple birth type: boolean patientmultipleBirthInteger: properties: multipleBirthInteger: description: Whether patient is part of a multiple birth type: integer . . . PatientEntry: type: FHIR_commons.Entry properties: resource: Patient PatientBundle: type: FHIR_commons.Bundle properties: entry?: PatientEntry[] ``` **出力例:** 'patientmultipleBirthBoolean', 'PatientBundle', 'patientmultipleBirthInteger', 'PatientEntry' ## [](#governance-api-validate)governance api validate `> governance api validate [options] ` このコマンドは、指定されたルールセットに対して ​`api-definition`​ で渡された API 定義を検証します。 `api-definition`​ は次のいずれかとして指定できます。 - API プロジェクト ZIP ファイル - API プロジェクトフォルダー - `--remote`​ オプションが指定されている場合は、API プロジェクトのアセット識別子。アセット識別子は、Exchange 内の各アセットを一意に識別するグループ ID、アセット ID、およびバージョン (GAV) です。 検証するルールセットを次のように指定できます。 - API プロジェクトのルールセットの連動関係を定義する既存の ​`exchange.json`​ ファイルを使用するには、​`api-definition`​ で指定したフォルダーまたは ZIP ファイルに含まれていることを確認してください。​`exchange.json`​ ファイルが存在する場合、このコマンドはすべての連動関係をダウンロードし、プロジェクトのルールセットに対して検証します。 - Exchange でパブリッシュされているルールセットに対して直接検証するには、​`--remote-rulesets`​ オプションを使用します。 - ローカルルールセットに対して検証するには、​`---rulesets`​ オプションを使用します。
重複するルールセットは検出されないため、同じコマンドの実行でルールセットを特定する前述の方法を複数使用すると、一部のルールセットが複数回検証される場合があります。
このコマンドでは、デフォルトの ​`--help`​、​`-f/--fields`​、​`-o/--output`​ オプション以外に次のオプションも使用できます。
オプション 説明

--rulesets <ruleset-yaml-file1>,<ruleset-yaml-file2>,…​

ローカルルールセット定義。​rulesets​ オプションの後には、ルールセット YAML ファイルのカンマ区切りリストが続きます。

--remote-rulesets <ruleset-asset-identifier>,<ruleset-asset-identifier>,…​

リモートルールセット定義。​remote-rulesets​ オプションの後には、ルールセットアセット識別子のカンマ区切りリストが続きます。アセット識別子は、Exchange 内の各アセットを一意に識別するグループ ID、アセット ID、およびバージョン (GAV) です。例: <group_id>/<asset_id>/<version>,<group_id>/<asset_id>/<version>​

Exchange アセット識別子 (GAV) を取得する​を参照してください。

--remote

パブリッシュされた API に対して検証を行う必要があることを示すフラグ。​api-definition​ で渡される値は、API のアセット識別子です。アセット識別子は、Exchange 内の各アセットを一意に識別するグループ ID、アセット ID、およびバージョン (GAV) です。例: <group_id>/<asset_id>/<version>​

Exchange アセット識別子 (GAV) を取得する​を参照してください。

**コマンド例:** ```copy anypoint-cli governance api validate ~/Downloads/order-api-1.0.0-raml.zip anypoint-cli governance api validate ~/Downloads/order-api-1.0.0-raml anypoint-cli governance api validate --rulesets /MyRulesets/ruleset1.yaml,/MyRulesets/ruleset2.yaml ~/Downloads/order-api-1.0.0-raml.zip anypoint-cli governance api validate --remote-rulesets 68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/1.0.1 ~/Downloads/order-api-1.0.0-raml.zip anypoint-cli governance api validate --remote-rulesets 68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/1.0.1 --remote 8a840abd-e63a-4f8b-87ab-24052eda2017/order-api/1.0.0 ``` **出力例:** ルールセットに適合する定義の場合: Spec conforms with Ruleset ルールセットに適合しない定義の場合: Conforms: false Number of results: 3 **(1)** Functional Validations ---------------------- Constraint: http://a.ml/vocabularies/amf/core#declaration-not-found Severity: Violation Message: not supported scalar for documentation Target: null Range: \[(6,3)-(6,3)\] Location: file:///Users/myuser/Downloads/order-api-1.0.0-raml/order-api-1.0.0-raml Conformance Validations **(2)** ----------------------- Constraint: file:///exchange\_modules/68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-best-practices/1.0.0/ruleset.yaml#/encodes/validations/api-must-have-documentation **(3)** Severity: Warning **(4)** Message: Provide the documentation for the API. **(5)** Target: amf://id#2 **(6)** Range: \[(2,0)-(6,4)\] **(7)** Location: file:///Users/myuser/Downloads/order-api-1.0.0-raml/order-api-1.0.0-raml **(8)** Constraint: file:///exchange\_modules/8a840abd-e63a-4f8b-87ab-24052eda2017/best-practices-ruleset/1.0.0/bestpractices.yaml#/encodes/validations/api-must-have-documentation Severity: Violation Message: Provide the documentation for the API Target: amf://id#2 Range: \[(2,0)-(6,4)\] Location: file:///Users/myuser/Downloads/order-api-1.0.0-raml/order-api-1.0.0-raml
1見つかった機能および準拠検証の問題の合計
2準拠の問題セクション
3この一連の問題が適用されるルールセットとルール
4問題の重要度
5問題の説明
6AMF モデルノード ID。AMF モデルについての詳細は、​「カスタムガバナンスルールセットの作成」​を参照
7問題が発生した API 定義の開始行番号と列および終了行番号と列。ここで、列は行の先頭からのオフセットであり、オフセットの番号は 0 で開始
8問題が発生したファイル (メインファイルまたはその連動関係のいずれか)
## [](#governance-document)governance document `> governance document [options] ` このコマンドは、​`ruleset`​ で指定された API Governance ルールセット定義 ZIP ファイルのドキュメントを作成します。ドキュメントを ​`doc-file`​ ZIP ファイルに含め、Exchange にアップロードしてパブリッシュできるようにします。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 **コマンド例:** ```copy anypoint-cli governance document ~/temp/ruleset.yaml ~/temp/ruleset.doc.zip ``` **出力例:** validation name \[ 'scalar-parameters' \] Saving to /Users/janedoe/temp/prof-1.doc.zip ## [](#governance-profile-create)governance profile create `> governance profile create [options] ` このコマンドは、​`profile-name`​ で指定された新しいガバナンスプロファイル名の文字列値を使用して、ガバナンスプロファイルを作成します。 `ruleset-asset-identifiers`​ を含める必要があります。これは、ルールセットアセット識別子のカンマ区切りのリストであり、それぞれが Exchange 内の各アセットを一意に識別するグループ ID、アセット ID、およびバージョン (GAV) です。例: `//,//`​。ここで、​``​ は ​`latest`​ の特定のバージョンです。バージョンとして ​`latest`​ を使用する場合、プロファイルの作成後にバージョンがパブリッシュされると、プロファイルはルールセットの最新バージョンを自動的に使用します。 `notify`​ オプションの 1 つを使用して、作成中のプロファイルの通知を設定できます。​`notify`​ オプションを使用しない場合、コマンドによって通知は設定されません。通知はデフォルトでオフになっています。 [Exchange アセット識別子 (GAV) を取得する](#exchange-asset-identifiers)​を参照してください。 このコマンドでは、デフォルトの ​`--help`​、​`-f/--fields`​、​`-o/--output`​ オプション以外に次のオプションも使用できます。
オプション 説明

--criteria <filtertype:filtervalue>,…​

検索条件を適用して、プロファイルルールセットが適用される API のリストを選択できます。カンマ区切りの検索条件のリストを指定します。各検索条件の種別と値は、​filtertype:filtervalue​ の形式です。

次のような検索条件を使用できます。

  • scope​: API 種別、​rest-api​ または ​async-api​

  • tag​: Exchange で API に対して定義されたタグ

  • category​: Exchange で API に対して定義されたカテゴリ。検索条件値は ​categoryName:value​ として 2 つの部分で指定されます。

  • status​: ライフサイクル状態 (安定、開発、または非推奨)

  • env-type​: 環境種別 (すべて、本番、または Sandbox)

  • env-id​: API Manager の環境名の ID。​[API Manager]​ > ​[Environment information (環境情報)]​ を使用してこの値を取得できます。​「環境の概念の確認」​を参照してください。

    env-type​ または ​env-id​ が使用されている場合、プロファイルに ​[API Instance (API インスタンス)]​ 検索条件が設定されるため、インスタンスが設定された API のみが絞り込まれます。開発ライフサイクルの API にはインスタンスを設定できません。

    CLI を使用してプロファイルの ​[API Instance (API インスタンス)]​ を選択解除するには、​env-type​ も ​env-id​ も含まれない ​--criteria​ フラグを使用してプロファイルを更新します。

例: tag:tag1,category:category1:value,category:category2:value2,status:stable,status:development,status:deprecated,scope:rest-api,scope:async-api,env-type:production

--tags <tags> Deprecated

Anypoint CLI バージョン v3.17.0 以降、​--criteria​ オプションが ​tags​ オプションの代わりに使用されます。​v3.17.0 より前のバージョンでは、​tags​ オプションの後には、新しいガバナンスプロファイルに適用される、​tag1,tag2,tag3​ 形式のタグのカンマ区切りリストが続きます。

--description <description>

description​ オプションの後には、新しいガバナンスプロファイルの説明である文字列が続きます。

--notify-contact

通知を有効にし、受信者を API に設定された取引先責任者に設定します。

--notify-publisher

通知を有効にし、受信者を API パブリッシャーに設定します。

--notify-others <email ID,email ID,…​>

通知を有効にし、受信者を指定されたメール ID のリストに設定します。

**コマンド例:** ```copy anypoint-cli governance profile create "Open API Best Practices" 68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/1.0.1 --criteria "tag:oas,category:API Type:Experience API,status:development,scope:rest-api" --description "Profile for OAS Best Practices" anypoint-cli governance profile create "Anypoint Best Practices" 68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-api-best-practices/1.0.1 --criteria "tag:raml tag:oas category:API Type:Experience API,status:stable,scope:rest-api" --description "Profile for REST API Best Practices" --notify-publisher --notify-contact --notify-others a@a.a,b@b.com anypoint-cli governance profile create "Primary API Standards" 68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/latest,68ef9520-24e9-4cf2-b2f5-620025690913/myorg-best-practices/1.0.2 --criteria "tag:prim,category:API Type:Experience API,status:stable,scope:rest-api,env-id:0683ce02-cd53-4028-a543-832a38a8af30" --description "Profile for Primary API Standards" ``` **出力例:** Profile Added Id 4f98e59d-8efb-420f-ac95-9cd0af15bd45 Name OAS Best Practices Description Profile for OAS Best Practices Rulesets gav://68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/1.0.1 Filter tag:best ## [](#governance-profile-delete)governance profile delete `> governance profile delete [options] ` このコマンドは、​`profile-id`​ によって指定される特定のガバナンスプロファイルを削除します。この ID を取得するには、​`governance profile info`​ または ​`governance profile list`​ コマンドを実行します。 `governance profile delete`​ コマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 **コマンド例:** ```copy anypoint-cli governance profile delete 8ffd463f-86b2-4132-afc6-44d179209362 ``` **出力例:** Profile with id 8ffd463f-86b2-4132-afc6-44d179209362 removed ## [](#governance-profile-info)governance profile info `> governance profile info [options] ` このコマンドは、ガバナンスプロファイル ID のすべての情報をリストします。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 **コマンド例:** ```copy anypoint-cli governance profile info 19fb211b-8775-43cc-865a-46228921d6ed --output text ``` **出力例:** Id 19fb211b-8775-43cc-865a-46228921d6ed Name Best Practices Description Best Practices Profile Rulesets 68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-best-practices/1.0.0 8a840abd-e63a-4f8b-87ab-24052eda2017/best-practices-ruleset/1.0.0 68ef9520-24e9-4cf2-b2f5-620025690913/required-examples/1.0.0 Criteria tag:best,category:API Type:Experience API,scope:rest-api NotificationConfig Contact,Publisher ## [](#governance-profile-list)governance profile list `> governance profile list [options]` このコマンドは、組織のすべてのガバナンスプロファイルの情報をリストします。ガバナンスプロファイルを更新するときに、この情報が必要です。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 **コマンド例:** ```copy anypoint-cli governance profile list -o text ``` **出力例:** Profile Name Profile Id Minimum Security Requirements 1f418cf4-b870-4b31-8734-f55f28d45f8f Best Practices 19fb211b-8775-43cc-865a-46228921d6ed New Best Practices 4eaf9176-3ef9-4021-a67c-6e4bc10d3763 OAS Standards 51ae8795-2278-407e-942f-becba29af986 ## [](#governance-profile-update)governance profile update `> governance profile update [options] ` このコマンドは、​`profile-id`​ で指定されるガバナンスプロファイルを更新します。この ID を取得するには、​`governance profile info`​ または ​`governance profile list`​ コマンドを実行します。 ガバナンスプロファイルの一般情報、ルールセット、検索条件、および通知設定を更新できます。​`notify`​ オプションの 1 つを使用して、通知設定を更新したり、通知を無効にしたりできます。すべての変更で、既存の通知設定が上書きされます。​`notify`​ オプションを使用しない場合、通知設定は変更されません。 このコマンドでは、デフォルトの ​`--help`​、​`-f/--fields`​、​`-o/--output`​ オプション以外に次のオプションも使用できます。
オプション 説明

--profile-name <profile-name>

profile-name​ オプションの後には、新しいガバナンスプロファイル名である文字列が続きます。

--ruleset-gavs <ruleset-gavs>

ruleset-gavs​ オプションは、各ルールセットのアセット識別子の ​<group_id>/<asset_id>/<version>,<group_id>/<asset_id>/<version>​ 形式のリストです。ここで、​<version>​ は特定のバージョンまたは ​latest​ です。アセット識別子は、Exchange 内の各アセットを識別する一意のグループ ID、アセット ID、およびバージョン (GAV) です。バージョンとして ​latest​ を使用する場合、プロファイルの作成後にバージョンがパブリッシュされると、プロファイルはルールセットの最新バージョンを自動的に使用します。

Exchange アセット識別子 (GAV) を取得する​を参照してください。

--criteria <filtertype:filtervalue>,…​

検索条件を適用して、プロファイルルールセットが適用される API のリストを選択できます。カンマ区切りの検索条件のリストを指定します。各検索条件の種別と値は、​filtertype:filtervalue​ の形式です。

次のような検索条件を使用できます。

  • scope​: API 種別、​rest-api​ または ​async-api​

  • tag​: Exchange で API に対して定義されたタグ

  • category​: Exchange で API に対して定義されたカテゴリ。検索条件値は ​categoryName:value​ として 2 つの部分で指定されます。

  • status​: ライフサイクル状態 (安定、開発、または非推奨)

  • env-type​: 環境種別 (すべて、本番、または Sandbox)

  • env-id​: API Manager の環境名の ID。​[API Manager]​ > ​[Environment information (環境情報)]​ を使用してこの値を取得できます。​「環境の概念の確認」​を参照してください。

    env-type​ または ​env-id​ が使用されている場合、プロファイルに ​[API Instance (API インスタンス)]​ 検索条件が設定されるため、インスタンスが設定された API のみが絞り込まれます。開発ライフサイクルの API にはインスタンスを設定できません。

    CLI を使用してプロファイルの ​[API Instance (API インスタンス)]​ を選択解除するには、​env-type​ も ​env-id​ も含まれない ​--criteria​ フラグを使用してプロファイルを更新します。

例: tag:tag1,category:category1:value,category:category2:value2,status:stable,status:development,status:deprecated,scope:rest-api,scope:async-api,env-type:production

--tags <tags> Deprecated

Anypoint CLI バージョン v3.17.0 以降、​--criteria​ オプションが ​tags​ オプションの代わりに使用されます。​v3.17.0 より前のバージョンでは、​tags​ オプションの後には、新しいガバナンスプロファイルに適用される、​tag1,tag2,tag3​ 形式のタグのカンマ区切りリストが続きます。

--description <description>

description​ オプションの後には、新しいガバナンスプロファイルの説明である文字列が続きます。

--notify-off

通知を無効にします。

--notify-contact

通知を有効にし、受信者を API に設定された取引先責任者に設定します。

--notify-publisher

通知を有効にし、受信者を API パブリッシャーに設定します。

--notify-others <email ID,email ID,…​>

通知を有効にし、受信者を指定されたメール ID のリストに設定します。

**コマンド例:** ```copy anypoint-cli governance profile update 4eaf9176-3ef9-4021-a67c-6e4bc10d3763 --profile-name "MyOrg Best Practices" anypoint-cli governance profile update 19fb211b-8775-43cc-865a-46228921d6ed --criteria `tag:best,category:API Type:Experience API,status:development,scope:rest-api` anypoint-cli governance profile update 67eff44a-28a3-43d4-93d9-bddedb92c711 --notify-publisher --notify-contact --notify-others a@a.a,b@b.com anypoint-cli governance profile update 67eff44a-28a3-43d4-93d9-bddedb92c711 --notify-off anypoint-cli governance profile update 19fb211b-8775-43cc-865a-46228921d6ed --criteria `tag:best,category:API Type:Experience API,status:production,scope:rest-api,env-type:production` --ruleset-gavs 68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/latest,68ef9520-24e9-4cf2-b2f5-620025690913/myorg-best-practices/latest ``` **出力例:** Profile updated 51f9f94c-fb0c-43d4-9895-22c9e64f1537 ### [](#制限事項)制限事項 `governance profile update`​ コマンドを使用して通知を設定することはできません。CLI を使用してプロファイルを作成したら、API Governance コンソールでプロファイルを編集して通知を設定できます。​[「API Governance コンソールを使用してガバナンスプロファイルを更新する」](https://docs.mulesoft.com/api-governance/create-profiles#update-a-governance-profile-using-the-api-governance-console)​を参照してください。 ## [](#governance-ruleset-clone)governance ruleset clone `> governance ruleset clone [options] ` このコマンドは、ガバナンスルールセットをコピーして新しいカスタムルールセットを作成し、オプションに基づいて指定された更新をルールに適用します。新しいルールセットが標準出力に書き込まれます。 `new-title`​ パラメーターでは、新しいルールセットのタイトルを指定します。 `new description`​ パラメーターでは、新しいルールセットのタイトルを指定します。
このコマンドを実行する前に、​governance ruleset info​ コマンドを実行して、このコマンドで使用するルール ID 情報を取得します。
このコマンドでは、デフォルトの ​`--help`​、​`-f/--fields`​、​`-o/--output`​ オプション以外に次のオプションも使用できます。
オプション 説明

--remote

コピーするルールセットが Exchange でパブリッシュされていること、および ​ruleset​ パラメーターがルールセットのアセット識別子であることを示します。アセット識別子は、Exchange 内の各アセットを一意に識別するグループ ID、アセット ID、およびバージョン (GAV) です。例: <group_id>/<asset_id>/<version>​

Exchange アセット識別子 (GAV) を取得する​を参照してください。

--error=<list_rules_to_move_to_error>

error​ オプションの後には、ルールセット YAML のエラーの重要度レベルセクションに移動するルールのルール ID が続きます。

--warning=<list_rules_to_move_to_warning>

warning​ オプションの後には、ルールセット YAML の警告の重要度レベルセクションに移動するルールのルール ID が続きます。

--info=<list_rules_to_move_to_info>

info​ オプションの後には、ルールセット YAML の情報の重要度レベルセクションに移動するルールのルール ID が続きます。

--remove=<list_rules_to_disable>

remove​ オプションの後には、ルールセット YAML でコメントアウトして実質的に無効にするルールのルール ID が続きます。

**コマンド例:** ```copy anypoint-cli governance ruleset clone ~/Downloads/ruleset.yaml 'New Ruleset from Clone' 'Cloned from ruleset.yaml' --warning=operation-default-response,operation-operationId > mynewruleset.yaml anypoint-cli governance ruleset clone 68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-best-practices/1.0.2 'Custom Anypoint Best Practices' 'Cloned from MuleSoft Anypoint Best Practices' --remote --remove=openapi-tags,operation-tags > my-anypoint-best-practices.yaml ``` ## [](#governance-ruleset-info)governance ruleset info `> governance ruleset info [options] ` このコマンドは、​`governance-ruleset`​ パラメーターで渡されたルールセット定義のルールセットルールをリストします。 このコマンドでは、デフォルトの ​`--help`​、​`-f/--fields`​、​`-o/--output`​ オプション以外に次のオプションも使用できます。
オプション 説明

--remote

情報を取得するルールセットが Exchange でパブリッシュされていること、および ​ruleset​ パラメーターがルールセットのアセット識別子であることを示します。アセット識別子は、Exchange 内のアセットを一意に識別するグループ ID、アセット ID、およびバージョン (GAV) です。例: <group_id>/<asset_id>/<version>​。ここで、​<version>​ は ​latest​ の特定のバージョンです。バージョンとして ​latest​ を使用する場合、プロファイルの作成後にバージョンがパブリッシュされると、プロファイルはルールセットの最新バージョンを自動的に使用します。

Exchange アセット識別子 (GAV) を取得する​を参照してください。

**コマンド例:** ```copy anypoint-cli governance ruleset info ~/temp/myruleset.yaml anypoint-cli governance ruleset info 68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-best-practices/1.0.2 --remote anypoint-cli governance ruleset info 68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-best-practices/latest --remote ``` **出力例:** Ruleset /Users/myuser/temp/myruleset.yaml Violation operation-default-response Violation operation-operationId Warning operation-singular-tag Warning tag-description Warning info-contact Warning info-description Warning info-license Warning license-url Warning openapi-tags Warning operation-description Warning operation-tags Warning operation-tag-defined ## [](#governance-ruleset-init)governance ruleset init `> governance ruleset init [options] ` このコマンドは、​`schema`​ パラメーターで渡されたデータスキーマに基づいてルールセットを初期化します。 このコマンドでは、デフォルトの ​`--help`​、​`-f/--fields`​、​`-o/--output`​ オプション以外に次のオプションも使用できます。
オプション 説明

--types <types>

types​ オプションは、ルールとしてエクスポートする対象種別を指定します。​governance api inspect​ コマンドを使用して、このオプションで指定する種別を特定できます。​governance api inspect​を参照してください。

--name <name>

name​ オプションはルールセットの名前です。デフォルトは ​GeneratedRuleset​ です。

**コマンド例:** ```copy anypoint-cli governance ruleset init --types patientmultipleBirthBoolean,patientBundle,patientmultipleBirthInteger --name=my-ruleset mydataschema ``` ## [](#governance-ruleset-validate)governance ruleset validate `> governance ruleset validate [options] ` このコマンドは、​`governance-ruleset`​ パラメーターを使用して渡されたルールセット定義を検証します。​`governance-ruleset`​ パラメーターとして、次のいずれかを渡すことができます。 - ルールセット定義 YAML ファイル - ルールセットをメインファイルとして指定する ​`exchange.json`​ ファイルを使用した API プロジェクトを含む ZIP ファイル - ルールセットをメインファイルとして指定する ​`exchange.json`​ ファイルを使用する API プロジェクトを含むフォルダー このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 **コマンド例:** ```copy anypoint-cli governance ruleset validate ~/temp/myruleset.yaml anypoint-cli governance ruleset validate ~/temp/myruleset.zip anypoint-cli governance ruleset validate ~/temp/myrulesetfolder ``` **有効なルールセットの出力例:** Ruleset conforms with Dialect **無効なルールセットの出力例:** Ruleset does not conform with Dialect ModelId: file:///Users/janedoe/temp/prof-1-bad.yaml Profile: Validation Profile 1.0 Conforms: false Number of results: 1 Level: Violation - Constraint: http://a.ml/amf/default\_document#/declarations/profileNode\_profile\_required\_validation Message: Property 'profile' is mandatory Severity: Violation Target: file:///Users/janedoe/temp/prof-1-bad.yaml#/encodes Property: http://schema.org/name Range: \[(3,0)-(11,19)\] Location: file:///Users/janedoe/temp/prof-1-bad.yaml ### [](#exchange-asset-identifiers)Exchange アセット識別子 (GAV) を取得する Exchange アセットの GAV を取得するには、次の操作を実行します。 - Exchange CLI を使用している場合、​`anypoint-cli exchange asset list`​ コマンドを実行します。 - Exchange Web UI を使用している場合、Exchange でアセットを選択し、URL からグループ ID とアセット ID をコピーします。表示しているバージョンのバージョンノードを追加します。たとえば、Exchange の「OpenAPI Best Practices (OpenAPI ベストプラクティス)」ルールセットの GAV は ​`68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/1.0.1`​ です。 # API Governance の CLI `governance`​ コマンドを使用して、API Governance のプロセスを自動化します。これらのコマンドの使用方法は、​[API Governance ドキュメント](https://docs.mulesoft.com/api-governance/)​を参照してください。

コマンド

説明

governance:api:evaluate

検索条件を評価して、その条件を満たす API に適用されるルールセットを決定する

governance:api:inspect

API 仕様を調べ、そのスキーマをリストする

governance:api:validate

指定されたガバナンスルールセットに対して API 仕様を検証する

governance:document

ガバナンスルールセット定義のドキュメントファイルを作成する

governance:profile:create

ガバナンスプロファイルを作成する

governance:profile:delete

ガバナンスプロファイルを削除する

governance:profile:info

特定のガバナンスプロファイル ID の情報をリストする

governance:profile:list

組織内のすべてのガバナンスプロファイルをリストする

governance:profile:update

ガバナンスプロファイルを更新する

governance:ruleset:clone

ガバナンスルールセットをコピーし、指定された更新をルールに適用する

governance:ruleset:info

ルールセットルールをリストする

governance:ruleset:init

データスキーマに基づいてガバナンスルールセット定義を初期化する

governance:ruleset:validate

ガバナンスルールセット定義の形式を検証する

## [](#governance-api-evaluate)governance:api:evaluate `> governance:api:evaluate [フラグ]` このコマンドは、指定された検索条件を評価して、その条件を満たす API に適用されるルールセットを決定します。 このコマンドでは、デフォルトのフラグ以外に次のフラグも受け入れます。
フラグ 説明

--api=<api>

評価する API プロジェクト。このコマンドは、プロジェクトの ​exchange.json​ ファイルの条件を使用します。

--criteria <filtertype:filtervalue>,…​

ルールセットを識別するために評価する検索条件を適用できます。カンマ区切りの検索条件のリストを指定します。各検索条件の種別と値は、​filtertype:filtervalue​ の形式です。

次のような検索条件を使用できます。

  • scope​: API 種別、​rest-api​ または ​async-api​

  • tag​: Exchange で API に対して定義されたタグ

  • category​: Exchange で API に対して定義されたカテゴリ。検索条件値は ​categoryName:value​ として 2 つの部分で指定されます。

  • env-type​: 環境種別 (すべて、本番、または Sandbox)

  • env-id​: API Manager の環境名の ID。​[API Manager]​ > ​[Environment information (環境情報)]​ を使用してこの値を取得できます。​「環境の概念の確認」​を参照してください。

    env-type​ または ​env-id​ が使用されている場合、プロファイルに ​[API Instance (API インスタンス)]​ 検索条件が設定されるため、インスタンスが設定された API のみが絞り込まれます。

    CLI を使用してプロファイルの ​[API Instance (API インスタンス)]​ を選択解除するには、​env-type​ も ​env-id​ も含まれない ​--criteria​ フラグを使用してプロファイルを更新します。

例: tag:tag1,category:category1:value,category:category2:value2,scope:rest-api,scope:async-api,env-type:production

このコマンドは、​--criteria​ または ​--api​ フラグを使用して実行する必要があります。
**コマンド例:** `anypoint-cli-v4 governance:api:evaluate --criteria "tag:best,category:API Type:Experience API,scope:rest-api"` `anypoint-cli-v4 governance:api:evaluate --api order-api-1.0.0-raml.zip` ここで、​`order-api-1.0.0-raml.zip`​ には API とその ​`exchange.json`​ ファイルが含まれています。 **出力例:** ╔════════════════════════════════════════════════════════════════════╗ ║ Ruleset GAV ║ ╟────────────────────────────────────────────────────────────────────╢ ║ 68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-best-practices/1.5.1 ║ ╟────────────────────────────────────────────────────────────────────╢ ║ 68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-best-practices/1.0.1 ║ ╚════════════════════════════════════════════════════════════════════╝ ## [](#governance-api-inspect)governance:api:inspect `> governance:api:inspect [フラグ] ` このコマンドは、​`api-specification`​ で渡された API 仕様を調べ、ヘッダー、要求、応答ペイロードなどのすべてのスキーマをリストします。このスキーマ情報は、​`governance:ruleset:init`​ コマンドで使用できます。​[governance:ruleset:init](#governance-ruleset-init)​を参照してください。 このコマンドでは、デフォルトのフラグのみを受け入れます。 **コマンド例:** ```copy anypoint-cli-v4 governance:api:inspect my-healthcare-api.yaml ``` **スキーマの例** ```copy types: patientmultipleBirthBoolean: properties: multipleBirthBoolean: description: Whether patient is part of a multiple birth type: boolean patientmultipleBirthInteger: properties: multipleBirthInteger: description: Whether patient is part of a multiple birth type: integer . . . PatientEntry: type: FHIR_commons.Entry properties: resource: Patient PatientBundle: type: FHIR_commons.Bundle properties: entry?: PatientEntry[] ``` **出力例:** 'patientmultipleBirthBoolean', 'PatientBundle', 'patientmultipleBirthInteger', 'PatientEntry' ## [](#governance-api-validate)governance:api:validate `> governance:api:validate [フラグ]` このコマンドは、指定されたルールセットに対して ​`api-specification`​ で渡された API 仕様を検証します。
このコマンドには複数オプションのフラグがあります。コマンドで複数オプションのフラグを使用する場合は、フラグの前にパラメーターを置くか、パラメーターの前に「-- 」(2 つのダッシュの後にスペース) を使用します。
`api-specification`​ は次のいずれかとして指定できます。 - API プロジェクト ZIP ファイル - API プロジェクトフォルダー - `--remote`​ フラグが指定されている場合は、API プロジェクトのアセット識別子。アセット識別子は、Exchange 内の各アセットを一意に識別するグループ ID、アセット ID、およびバージョン (GAV) です。 検証するルールセットを次のように指定できます。 - API プロジェクトのルールセットの連動関係を定義する既存の ​`exchange.json`​ ファイルを使用するには、​`api-specification`​ で指定したフォルダーまたは ZIP ファイルに ​`exchange.json`​ ファイルが含まれていることを確認してください。​`exchange.json`​ ファイルが存在する場合、このコマンドはすべてのルールセット連動関係をダウンロードし、それらのルールセットに対して検証します。ルールセットの連動関係は、API Designer でその API プロジェクトに連動関係が定義されている場合にのみ、​`exchange.json`​ ファイルに存在します。​[「プロジェクトへのルールセットの追加」](https://docs.mulesoft.com/api-governance/find-conformance-issues#add-rulesets)​を参照してください。 - Exchange でパブリッシュされているルールセットに対して直接検証するには、​`--remote-rulesets`​ フラグを使用します。 - ローカルルールセットに対して検証するには、​`---rulesets`​ フラグを使用します。
重複するルールセットは検出されないため、同じコマンドの実行でルールセットを特定する前述の方法を複数使用すると、一部のルールセットが複数回検証される場合があります。
このコマンドでは、デフォルトのフラグ以外に次のフラグも受け入れます。
フラグ 説明

--rulesets <ruleset-yaml-file1> <ruleset-yaml-file2> …​

ローカルルールセット定義。​rulesets​ フラグの後には、カンマで区切られたルールセット YAML ファイルのリストが続きます。

--remote-rulesets <ruleset-asset-identifier> <ruleset-asset-identifier> …​

リモートルールセット定義。​remote-rulesets​ フラグの後には、カンマで区切られたルールセットアセット識別子のリストが続きます。アセット識別子は、Exchange 内の各アセットを一意に識別するグループ ID、アセット ID、およびバージョン (GAV) です。例: <group_id>/<asset_id>/<version>,<group_id>/<asset_id>/<version>​

Exchange アセット識別子 (GAV) を取得する​を参照してください。

--remote

パブリッシュされた API に対して検証を行う必要があることを示すフラグ。​api-specification​ で渡される値は、API のアセット識別子です。アセット識別子は、Exchange 内の各アセットを一意に識別するグループ ID、アセット ID、およびバージョン (GAV) です。例: <group_id>/<asset_id>/<version>​

Exchange アセット識別子 (GAV) を取得する​を参照してください。

**コマンド例:** ```copy anypoint-cli-v4 governance:api:validate /MyApis/order-api-1.0.0-raml.zip anypoint-cli-v4 governance:api:validate /MyApis/order-api-1.0.0-raml anypoint-cli-v4 governance:api:validate /MyApis/order-api-1.0.0-raml.zip --rulesets /MyRulesets/ruleset1.yaml /MyRulesets/ruleset2.yaml anypoint-cli-v4 governance:api:validate /MyApis/order-api-1.0.0-raml.zip --remote-rulesets 68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/1.0.1 anypoint-cli-v4 governance:api:validate 8a840abd-e63a-4f8b-87ab-24052eda2017/order-api/1.0.0 --remote-rulesets 68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/1.0.1 --remote ``` **出力例:** ルールセットに適合する仕様の場合: Spec conforms with Ruleset ルールセットに適合しない仕様の場合: Conforms: false Number of results: 3 **(1)** Functional Validations ---------------------- Constraint: http://a.ml/vocabularies/amf/core#declaration-not-found Severity: Violation Message: not supported scalar for documentation Target: null Range: \[(6,3)-(6,3)\] Location: file:///Users/myuser/Downloads/order-api-1.0.0-raml/order-api-1.0.0-raml Conformance Validations **(2)** ----------------------- Constraint: file:///exchange\_modules/68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-best-practices/1.0.0/ruleset.yaml#/encodes/validations/api-must-have-documentation **(3)** Severity: Warning **(4)** Message: Provide the documentation for the API. **(5)** Target: amf://id#2 **(6)** Range: \[(2,0)-(6,4)\] **(7)** Location: file:///Users/myuser/Downloads/order-api-1.0.0-raml/order-api-1.0.0-raml **(8)** Constraint: file:///exchange\_modules/8a840abd-e63a-4f8b-87ab-24052eda2017/best-practices-ruleset/1.0.0/bestpractices.yaml#/encodes/validations/api-must-have-documentation Severity: Violation Message: Provide the documentation for the API Target: amf://id#2 Range: \[(2,0)-(6,4)\] Location: file:///Users/myuser/Downloads/order-api-1.0.0-raml/order-api-1.0.0-raml
1見つかった機能および準拠検証の問題の合計
2準拠の問題セクション
3この一連の問題が適用されるルールセットとルール
4問題の重要度
5問題の説明
6AMF モデルノード ID。AMF モデルについての詳細は、​「カスタムガバナンスルールセットの作成」​を参照
7問題が発生した API 仕様の開始行番号と列および終了行番号と列。ここで、列は行の先頭からのオフセットであり、オフセットの番号は 0 で開始
8問題が発生したファイル (メインファイルまたはその連動関係のいずれか)
## [](#governance-document)governance:document `> governance:document [フラグ] ` このコマンドは、​`ruleset`​ で指定された API Governance ルールセット定義 ZIP ファイルのドキュメントを作成します。ドキュメントを ​`doc-file`​ ZIP ファイルに含め、Exchange にアップロードしてパブリッシュできるようにします。 このコマンドでは、デフォルトのフラグのみを受け入れます。 **コマンド例:** ```copy anypoint-cli-v4 governance:document /myrulesetfolder/mynewruleset.yaml /myrulesetfolder/ruleset.doc.zip ``` **出力例:** validation name \[ 'security-fields-operation-empty' \] validation name \[ 'access-tokens-oauth2-cleartext' \] validation name \[ 'insecure-oauth2-grants' \] validation name \[ 'api-keys-in-cookie' \] validation name \[ 'api-keys-in-query' \] validation name \[ 'api-keys-in-header' \] validation name \[ 'api-negotiates-authentication' \] validation name \[ 'insecure-basic-auth' \] validation name \[ 'bearer-token-cleartext' \] validation name \[ 'http-token-cleartext' \] validation name \[ 'oauth1-deprecated' \] validation name \[ 'oauth2-redirections-non-encrypted' \] validation name \[ 'unknown-security-scheme' \] validation name \[ 'valid-server-urltemplate' \] validation name \[ 'valid-oauth2-redirection-urls' \] Saving to myRulesetFolder/ruleset.doc.zip ## [](#governance-profile-create)governance:profile:create `> governance:profile:create [フラグ] ` このコマンドは、​`profile-name`​ で指定された新しいガバナンスプロファイル名の文字列値を使用して、ガバナンスプロファイルを作成します。 `ruleset-asset-identifiers`​ を含める必要があります。これは、ルールセットアセット識別子のカンマ区切りのリストであり、それぞれが Exchange 内の各アセットを一意に識別するグループ ID、アセット ID、およびバージョン (GAV) です。例: `//,//`​。ここで、​``​ は ​`latest`​ の特定のバージョンです。バージョンとして ​`latest`​ を使用する場合、プロファイルの作成後にバージョンがパブリッシュされると、プロファイルはルールセットの最新バージョンを自動的に使用します。​[Exchange アセット識別子 (GAV) を取得する](#exchange-asset-identifiers)​を参照してください。 `notify`​ フラグの 1 つを使用して、作成中のプロファイルの通知を設定できます。​`notify`​ フラグを使用しない場合、コマンドによって通知は設定されません。通知はデフォルトでオフになっています。 このコマンドでは、デフォルトのフラグ以外に次のフラグも受け入れます。
フラグ 説明

--criteria <filtertype:filtervalue>,…​

検索条件を適用して、プロファイルルールセットが適用される API のリストを選択できます。カンマ区切りの検索条件のリストを指定します。各検索条件の種別と値は、​filtertype:filtervalue​ の形式です。

次のような検索条件を使用できます。

  • scope​: API 種別、​rest-api​ または ​async-api​

  • tag​: Exchange で API に対して定義されたタグ

  • category​: Exchange で API に対して定義されたカテゴリ。検索条件値は ​categoryName:value​ として 2 つの部分で指定されます。

  • env-type​: 環境種別 (すべて、本番、または Sandbox)

  • env-id​: API Manager の環境名の ID。​[API Manager]​ > ​[Environment information (環境情報)]​ を使用してこの値を取得できます。​「環境の概念の確認」​を参照してください。

    env-type​ または ​env-id​ が使用されている場合、プロファイルに ​[API Instance (API インスタンス)]​ 検索条件が設定されるため、インスタンスが設定された API のみが絞り込まれます。

    CLI を使用してプロファイルの ​[API Instance (API インスタンス)]​ を選択解除するには、​env-type​ も ​env-id​ も含まれない ​--criteria​ フラグを使用してプロファイルを更新します。

例: tag:tag1,category:category1:value,category:category2:value2,scope:rest-api,scope:async-api,env-type:production

--description <description>

description​ フラグの後には、新しいガバナンスプロファイルの説明である文字列が続きます。

--notify-contact

通知を有効にし、受信者を API に設定された取引先責任者に設定します。

--notify-publisher

通知を有効にし、受信者を API パブリッシャーに設定します。

--notify-others <email ID,email ID,…​>

通知を有効にし、受信者を指定されたメール ID のリストに設定します。

**コマンド例:** ```copy anypoint-cli-v4 governance:profile:create "OAS Best Practices" 68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/1.0.1 --criteria "tag:oas,category:API Type:Experience API,scope:rest-api" --description "Profile for OAS Best Practices" anypoint-cli-v4 governance:profile:create "Open API Best Practices" 68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/1.0.1 --criteria "tag:oas,category:API Type:Experience API,scope:rest-api" --description "Profile for OAS Best Practices" anypoint-cli-v4 governance:profile:create "Anypoint Best Practices" 68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-api-best-practices/1.0.1 --criteria "tag:raml tag:oas category:API Type:Experience API,scope:rest-api" --description "Profile for REST API Best Practices" --notify-publisher --notify-contact --notify-others a@a.a,b@b.com anypoint-cli-v4 governance:profile:create "Primary API Standards" 68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/latest,68ef9520-24e9-4cf2-b2f5-620025690913/myorg-best-practices/1.0.2 --criteria "tag:prim,category:API Type:Experience API,scope:rest-api" --description "Profile for Primary API Standards" ``` **出力例:** Profile Added Id 4f98e59d-8efb-420f-ac95-9cd0af15bd45 Name OAS Best Practices Description Profile for OAS Best Practices Rulesets gav://68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/1.0.1 Filter tag:best ## [](#governance-profile-delete)governance:profile:delete `> governance:profile:delete [フラグ] ` このコマンドは、​`profile-id`​ によって指定された特定のガバナンスプロファイルを削除します。 この ID を取得するには、​`governance:profile:info`​ または ​`governance:profile:list`​ コマンドを実行します。 `governance:profile:delete`​ コマンドでは、デフォルトのフラグのみを受け入れます。 **コマンド例:** ```copy anypoint-cli-v4 governance:profile:delete 8ffd463f-86b2-4132-afc6-44d179209362 ``` **出力例:** Profile with id 8ffd463f-86b2-4132-afc6-44d179209362 removed ## [](#governance-profile-info)governance:profile:info `> governance:profile:info [フラグ] ` このコマンドは、ガバナンスプロファイル ID のすべての情報をリストします。 このコマンドでは、デフォルトのフラグ以外に次のフラグも受け入れます。
フラグ 説明

--output <output-format>

コマンド出力の形式。サポートされている値は、​table​ (デフォルト) および ​json​ です。

**コマンド例:** ```copy anypoint-cli-v4 governance:profile:info 19fb211b-8775-43cc-865a-46228921d6ed ``` **出力例:** Id 19fb211b-8775-43cc-865a-46228921d6ed Name Best Practices Description Best Practices Profile Rulesets 68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-best-practices/1.0.0 8a840abd-e63a-4f8b-87ab-24052eda2017/best-practices-ruleset/1.0.0 68ef9520-24e9-4cf2-b2f5-620025690913/required-examples/1.0.0 Criteria tag:best,category:API Type:Experience API,scope:rest-api NotificationConfig Contact,Publisher ## [](#governance-profile-list)governance:profile:list `> governance:profile:list [フラグ]` このコマンドは、組織のすべてのガバナンスプロファイルの情報をリストします。ガバナンスプロファイルを更新するときに、この情報が必要です。 このコマンドでは、デフォルトのフラグ以外に次のフラグも受け入れます。
フラグ 説明

--output <output-format>

コマンド出力の形式。サポートされている値は、​table​ (デフォルト) および ​json​ です。

**コマンド例:** ```copy anypoint-cli-v4 governance:profile:list ``` **出力例:** Profile Name Profile Id Minimum Security Requirements 1f418cf4-b870-4b31-8734-f55f28d45f8f Best Practices 19fb211b-8775-43cc-865a-46228921d6ed New Best Practices 4eaf9176-3ef9-4021-a67c-6e4bc10d3763 OAS Standards 51ae8795-2278-407e-942f-becba29af986 ## [](#governance-profile-update)governance:profile:update `> governance:profile:update [フラグ] ` このコマンドは、​`profile-id`​ で指定されるガバナンスプロファイルを更新します。 この ID を取得するには、​`governance:profile:info`​ または ​`governance:profile:list`​ コマンドを実行します。 ガバナンスプロファイルの一般情報、ルールセット、検索条件、および通知設定を更新できます。​`notify`​ フラグの 1 つを使用して、通知設定を更新したり、通知を無効にしたりできます。すべての変更で、既存の通知設定が上書きされます。​`notify`​ フラグを使用しない場合、通知設定は変更されません。 このコマンドでは、デフォルトのフラグ以外に次のフラグも受け入れます。
フラグ 説明

--profile-name <profile-name>

profile-name​ フラグの後には、新しいガバナンスプロファイル名である文字列が続きます。

--ruleset-gavs <ruleset-gavs>

ruleset-gavs​ フラグの後には、各ルールセットのアセット識別子の ​<group_id>/<asset_id>/<version>,<group_id>/<asset_id>/<version>​ 形式のリストが続きます。ここで、​<version>​ は特定のバージョンまたは ​latest​ です。アセット識別子は、Exchange 内の各アセットを識別する一意のグループ ID、アセット ID、およびバージョン (GAV) です。バージョンとして ​latest​ を使用する場合、プロファイルの作成後にバージョンがパブリッシュされると、プロファイルはルールセットの最新バージョンを自動的に使用します。

Exchange アセット識別子 (GAV) を取得する​を参照してください。

--criteria <filtertype:filtervalue>,…​

検索条件を適用して、プロファイルルールセットが適用される API のリストを選択できます。カンマ区切りの検索条件のリストを指定します。各検索条件の種別と値は、​filtertype:filtervalue​ の形式です。

次のような検索条件を使用できます。

  • scope​: API 種別、​rest-api​ または ​async-api​

  • tag​: Exchange で API に対して定義されたタグ

  • category​: Exchange で API に対して定義されたカテゴリ。検索条件値は ​categoryName:value​ として 2 つの部分で指定されます。

  • env-type​: 環境種別 (すべて、本番、または Sandbox)

  • env-id​: API Manager の環境名の ID。​[API Manager]​ > ​[Environment information (環境情報)]​ を使用してこの値を取得できます。​「環境の概念の確認」​を参照してください。

    env-type​ または ​env-id​ が使用されている場合、プロファイルに ​[API Instance (API インスタンス)]​ 検索条件が設定されるため、インスタンスが設定された API のみが絞り込まれます。

    CLI を使用してプロファイルの ​[API Instance (API インスタンス)]​ を選択解除するには、​env-type​ も ​env-id​ も含まれない ​--criteria​ フラグを使用してプロファイルを更新します。

例: tag:tag1,category:category1:value,category:category2:value2,scope:rest-api,scope:async-api,env-type:production

--description <description>

description​ フラグの後には、新しいガバナンスプロファイルの説明である文字列が続きます。

--notify-off

通知を無効にします。

--notify-contact

通知を有効にし、受信者を API に設定された取引先責任者に設定します。

--notify-publisher

通知を有効にし、受信者を API パブリッシャーに設定します。

--notify-others <email ID,email ID,…​>

通知を有効にし、受信者を指定されたメール ID のリストに設定します。

**コマンド例:** ```copy anypoint-cli-v4 governance:profile:update 4eaf9176-3ef9-4021-a67c-6e4bc10d3763 --profile-name "MyOrg Best Practices" anypoint-cli-v4 governance:profile:update 19fb211b-8775-43cc-865a-46228921d6ed --criteria `tag:best,category:API Type:Experience API,scope:rest-api` anypoint-cli-v4 governance profile update 67eff44a-28a3-43d4-93d9-bddedb92c711 --notify-publisher --notify-contact --notify-others a@a.a,b@b.com anypoint-cli-v4 governance profile update 67eff44a-28a3-43d4-93d9-bddedb92c711 --notify-off anypoint-cli-v4 governance profile update 19fb211b-8775-43cc-865a-46228921d6ed --criteria `tag:best,category:API Type:Experience API,scope:rest-api,env-type:production` --ruleset-gavs 68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/latest,68ef9520-24e9-4cf2-b2f5-620025690913/myorg-best-practices/latest ``` **出力例:** Profile updated 51f9f94c-fb0c-43d4-9895-22c9e64f1537 ## [](#governance-ruleset-clone)governance:ruleset:clone `> governance:ruleset:clone [フラグ] ` このコマンドは、ガバナンスルールセットをコピーして新しいカスタムルールセットを作成し、フラグに基づいて指定された更新をルールに適用します。新しいルールセットが標準出力に書き込まれます。 `new-title`​ パラメーターでは、新しいルールセットのタイトルを指定します。 `new description`​ パラメーターでは、新しいルールセットのタイトルを指定します。
このコマンドを実行する前に、​governance:ruleset:info​ コマンドを実行して、このコマンドで使用するルール ID 情報を取得します。
このコマンドでは、デフォルトのフラグ以外に次のフラグも受け入れます。
フラグ 説明

--remote

コピーするルールセットが Exchange でパブリッシュされていること、および ​ruleset​ パラメーターがルールセットのアセット識別子であることを示します。アセット識別子は、Exchange 内の各アセットを一意に識別するグループ ID、アセット ID、およびバージョン (GAV) です。例: <group_id>/<asset_id>/<version>​

Exchange アセット識別子 (GAV) を取得する​を参照してください。

--error=<list_rules_to_move_to_error>

error​ フラグの後には、ルールセット YAML のエラーの重要度レベルセクションに移動するルールのルール ID が続きます。

--warning=<list_rules_to_move_to_warning>

warning​ フラグの後には、ルールセット YAML の警告の重要度レベルセクションに移動するルールのルール ID が続きます。

--info=<list_rules_to_move_to_info>

info​ フラグの後には、ルールセット YAML の情報の重要度レベルセクションに移動するルールのルール ID が続きます。

--remove=<list_rules_to_disable>

remove​ フラグの後には、ルールセット YAML でコメントアウトして実質的に無効にするルールのルール ID が続きます。

**コマンド例:** ```copy anypoint-cli-v4 governance:ruleset:clone ~/Downloads/ruleset.yaml 'New Ruleset from Clone' 'Cloned from ruleset.yaml' --warning=operation-default-response,operation-operationId > mynewruleset.yaml anypoint-cli-v4 governance:ruleset:clone 68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-best-practices/1.0.2 'Custom Anypoint Best Practices' 'Cloned from MuleSoft Anypoint Best Practices' --remote --remove=openapi-tags,operation-tags > my-anypoint-best-practices.yaml ``` ## [](#governance-ruleset-info)governance:ruleset:info `> governance:ruleset:info [フラグ]` このコマンドは、​`governance-ruleset`​ パラメーターで渡されたルールセット定義のルールセットルールをリストします。
このコマンドには複数オプションのフラグがあります。コマンドで複数オプションのフラグを使用する場合は、フラグの前にパラメーターを置くか、パラメーターの前に「-- 」(2 つのダッシュの後にスペース) を使用します。
このコマンドでは、デフォルトのフラグ以外に次のフラグも受け入れます。
フラグ 説明

--remote

情報を取得するルールセットが Exchange でパブリッシュされていること、および ​ruleset​ パラメーターがルールセットのアセット識別子であることを示します。アセット識別子は、Exchange 内のアセットを一意に識別するグループ ID、アセット ID、およびバージョン (GAV) です。例: <group_id>/<asset_id>/<version>​。ここで、​<version>​ は ​latest​ の特定のバージョンです。バージョンとして ​latest​ を使用する場合、プロファイルの作成後にバージョンがパブリッシュされると、プロファイルはルールセットの最新バージョンを自動的に使用します。

Exchange アセット識別子 (GAV) を取得する​を参照してください。

**コマンド例:** ```copy anypoint-cli-v4 governance:ruleset:info myrulesetfolder/myruleset.yaml anypoint-cli-v4 governance:ruleset:info 68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-best-practices/1.0.2 --remote anypoint-cli-v4 governance:ruleset:info 68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-best-practices/latest --remote ``` **出力例:** Ruleset myrulesetfolder/myruleset.yaml Ruleset conforms with Dialect ╔═══════════╤═══════════════════════════════════╗ ║ Violation │ security-fields-operation-empty ║ ╟───────────┼───────────────────────────────────╢ ║ Violation │ access-tokens-oauth2-cleartext ║ ╟───────────┼───────────────────────────────────╢ ║ Violation │ insecure-oauth2-grants ║ ╟───────────┼───────────────────────────────────╢ ║ Violation │ api-keys-in-cookie ║ ╟───────────┼───────────────────────────────────╢ ║ Violation │ api-keys-in-query ║ ╟───────────┼───────────────────────────────────╢ ║ Violation │ api-keys-in-header ║ ╟───────────┼───────────────────────────────────╢ ║ Violation │ api-negotiates-authentication ║ ╟───────────┼───────────────────────────────────╢ ║ Violation │ insecure-basic-auth ║ ╟───────────┼───────────────────────────────────╢ ║ Violation │ bearer-token-cleartext ║ ╟───────────┼───────────────────────────────────╢ ║ Violation │ http-token-cleartext ║ ╟───────────┼───────────────────────────────────╢ ║ Violation │ oauth2-redirections-non-encrypted ║ ╟───────────┼───────────────────────────────────╢ ║ Violation │ unknown-security-scheme ║ ╟───────────┼───────────────────────────────────╢ ║ Violation │ valid-server-urltemplate ║ ╟───────────┼───────────────────────────────────╢ ║ Violation │ valid-oauth2-redirection-urls ║ ╟───────────┼───────────────────────────────────╢ ║ Warning │ unknown-security-scheme ║ ╟───────────┼───────────────────────────────────╢ ║ Warning │ oauth1-deprecated ║ ╚═══════════╧═══════════════════════════════════╝ ## [](#governance-ruleset-init)governance:ruleset:init `> governance:ruleset:init [フラグ] ` このコマンドは、​`schema`​ パラメーターで渡されたデータスキーマに基づいてルールセットを初期化します。 このコマンドでは、デフォルトのフラグ以外に次のフラグも受け入れます。
フラグ 説明

--types <types>

types​ フラグは、ルールとしてエクスポートする対象種別を指定します。​governance:api:inspect​ コマンドを使用して、このフラグで指定する種別を特定できます。​governance:api:inspect​を参照してください。

--name <name>

name​ フラグはルールセットの名前です。デフォルトは ​GeneratedRuleset​ です。

**コマンド例:** ```copy anypoint-cli-v4 governance:ruleset:init --types patientmultipleBirthBoolean,patientBundle,patientmultipleBirthInteger --name=my-ruleset mydataschema ``` ## [](#governance-ruleset-validate)governance:ruleset:validate `> governance:ruleset:validate [フラグ] ` このコマンドは、​`governance-ruleset`​ パラメーターを使用して渡されたルールセット定義を検証します。​`governance-ruleset`​ パラメーターとして、次のいずれかを渡すことができます。 - ルールセット定義 YAML ファイル - ルールセットをメインファイルとして指定する ​`exchange.json`​ ファイルを使用した API プロジェクトを含む ZIP ファイル - ルールセットをメインファイルとして指定する ​`exchange.json`​ ファイルを使用する API プロジェクトを含むフォルダー このコマンドでは、デフォルトのフラグのみを受け入れます。 **コマンド例:** ```copy anypoint-cli-v4 governance:ruleset:validate ~/myrulesetfolder/myruleset.yaml anypoint-cli-v4 governance:ruleset:validate ~/myrulesetfolder/myruleset.zip anypoint-cli-v4 governance:ruleset:validate ~/myrulesetfolder/myrulesetfolder ``` **有効なルールセットの出力例:** Ruleset User/myuser/myrulesetfolder/myruleset.yaml Ruleset conforms with Dialect **無効なルールセットの出力例:** Ruleset does not conform with Dialect ModelId: file:///Users/myuser/myrulesetfolder/prof-1-bad.yaml Profile: Validation Profile 1.0 Conforms: false Number of results: 1 Level: Violation - Constraint: http://a.ml/amf/default\_document#/declarations/profileNode\_profile\_required\_validation Message: Property 'profile' is mandatory Severity: Violation Target: file:///Users/myuser/myrulesetfolder/prof-1-bad.yaml#/encodes Property: http://schema.org/name Range: \[(3,0)-(11,19)\] Location: file:///Users/myuser/myrulesetfolder/prof-1-bad.yaml ### [](#exchange-asset-identifiers)Exchange アセット識別子 (GAV) を取得する Exchange アセットの GAV を取得するには、次の操作を実行します。 - Exchange CLI を使用している場合、​`exchange:asset:list`​ コマンドを実行します。 - Exchange Web UI を使用している場合、Exchange でアセットを選択し、URL からグループ ID とアセット ID をコピーします。次に、表示しているバージョンのバージョンノードを追加します。たとえば、Exchange の「OpenAPI Best Practices (OpenAPI ベストプラクティス)」ルールセットの GAV は ​`68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/1.0.1`​ です。 # API Manager の CLI
コマンド 説明

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 層をリストする

## [](#api-mgr-alert-add)api-mgr alert add \> api-mgr alert add \[options\] このコマンドは、​``​ で渡される 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 \> api-mgr alert list \[options\] ``​ で渡される 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 \> api-mgr api change-specification \[options\] ``​ で渡される Exchange の新しいバージョンを選択して、​` api-mgr api classify \[options\] ``​ で渡される環境の ​``​ で渡される API インスタンスを分類します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#api-mgr-api-delete)api-mgr api delete \> api-mgr api delete \[options\] このコマンドは、​``​ で渡される API インスタンスを削除します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#api-mgr-api-deploy)api-mgr api deploy \> api-mgr api deploy \[options\] このコマンドは、 で渡される 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 \> api-mgr api deprecate \[options\] ``​ で渡される API インスタンスを非推奨にします。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#api-mgr-api-describe)api-mgr api describe \> api-mgr api describe \[options\] ``​ で渡される API インスタンスの詳細を表示します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#api-mgr-api-download-proxy)api-mgr api download-proxy \> api-mgr api download-proxy \[options\] このコマンドは、​``​ で渡される API インスタンスの API プロキシ ZIP ファイルを ​``​ で指定されるローカルディレクトリにダウンロードします。 このコマンドでは、デフォルトの ​`--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 \> api-mgr api edit \[options\] ``​ で渡される 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​ です。

--endpointUri <value>

コンシューマーエンドポイント URI。

--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 \> 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 \> api-mgr api manage \[options\] ``​ で渡される Exchange アセット (​``​ で渡されるバージョン) を使用して、新しい 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​ です。

--endpointUri <value>

コンシューマーエンドポイント URI。

--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 \> api-mgr api promote \[options\] ``​ で渡される昇格元環境の ​``​ で渡される 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 \> api-mgr api redeploy \[options\] ``​ で渡される 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 \> api-mgr api undeprecate \[options\] ``​ で渡される API インスタンスの非推奨を解除します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#api-mgr-contract-delete)api-mgr contract delete \> api-mgr contract delete \[options\] このコマンドは、​``​ で渡される API インスタンスと ​``​ で渡されるクライアント間のコントラクトを削除します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#api-mgr-contract-list)api-mgr contract list \> api-mgr contract list \[options\] \[searchText\] ``​ で渡される 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 \> api-mgr policy apply \[options\] ``​ で渡されるポリシーを ​``​ で渡される API インスタンスに適用します。
オプション 説明

--policyVersion <value>

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

--groupId <value>

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

-c, --config [configJSON]

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

--configFile [file]

設定データをファイルとして渡す。
(例: api-mgr policy apply --configFile ./config.json​)。

-p, --pointcut [dataJSON]

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

次の例では、レート制限を 10 秒ごとに 1 件の要求として定義しています。 { "rateLimits": \[{ "maximumRequests": 1, "timePeriodInMilliseconds": 10000 }\], "clusterizable": true, "exposeHeaders": false } ## [](#api-mgr-policy-describe)api-mgr policy describe \> api-mgr policy describe \[options\] このコマンドは、​``​ で渡されるポリシーの情報と使用可能な設定プロパティを表示します。 このコマンドでは、デフォルトの ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ オプション以外に次のオプションも使用できます。
オプション 説明

--policyVersion <value>

Mule4 ポリシーバージョン。

--groupId <value>

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

## [](#api-mgr-policy-disable)api-mgr policy disable \> api-mgr policy disable \[options\] このコマンドは、​``​ で渡される API インスタンスの ​``​ で渡されるポリシーを無効にします。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#api-mgr-policy-edit)api-mgr policy edit \> api-mgr policy edit \[options\] このコマンドは、​``​ で渡される API インスタンスの ​``​ で渡されるポリシー設定を編集にします。 このコマンドでは、デフォルトの ​`--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 \> api-mgr policy enable \[options\] このコマンドは、​``​ で渡される API インスタンスの ​``​ で渡されるポリシーを有効にします。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#api-mgr-policy-list)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 \> api-mgr policy remove \[options\] このコマンドは、​``​ で渡される API インスタンスから ​``​ で指定されるポリシーを削除します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#api-mgr-tier-add)api-mgr tier add \> api-mgr tier add \[options\] このコマンドは、​``​ で渡される API インスタンスの SLA 層を作成します。 このコマンドでは、デフォルトの ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ オプション以外に次のオプションも使用できます。
オプション 説明

-a, --autoApprove

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

--name <value>

層の名前

--description <value>

層の情報

-l, --limit <value>

--limit A,B,C​ 形式の SLA 層の制限の単一インスタンス。

  • A​ はこの制限を表示する必要があるかどうかを示すブール。

  • B​ は「C」期間ごとの要求数。

  • C​ は期間の単位。期間のオプションは、次のとおりです。

    • ms​ (ミリ秒)

    • sec​ (秒)

    • min​ (分)

    • hr​ (時間)

    • d​(day)

    • wk​ (週)

    • mo​ (月)

    • yr​ (年)

例: --limit true,100,min​ は、100 要求/分の制限 (visible) です。

複数の制限を作成するために、複数の ​--limit​ オプションを指定できます。
例: -l true,100,sec -l false,20,min​
## [](#api-mgr-tier-copy)api-mgr tier copy \> api-mgr tier copy \[options\] このコマンドは、​``​ で渡される API インスタンスから ​``​ で渡される API インスタンス ID に SLA 層をコピーします。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#api-mgr-tier-delete)api-mgr tier delete \> api-mgr tier delete \[options\] このコマンドは、​``​ で渡される API インスタンスから ​``​ で渡される SLA 層を削除します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#api-mgr-tier-list)api-mgr tier list \> api-mgr tier list \[options\] \[searchText\] このコマンドは、​``​ で渡される 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"

# API Manager の CLI
コマンド 説明

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 層をリストする

## [](#common-options)一般フラグと認証フラグ Anypoint Platform に対して認証するコマンドの一般フラグと認証フラグを次に示します。
フラグ 説明

--client_id=client_id​

または

ANYPOINT_CLIENT_ID​ 環境変数

接続アプリケーションクライアント ID。

「認証」​を参照してください。

--client_secret​

または

ANYPOINT_CLIENT_SECRET​ 環境変数

クライアント ID の接続アプリケーションシークレットのプロンプト。

​「認証」​を参照してください。

--collectMetrics​

または

COLLECT_METRICS​ 環境変数

現在使用されていません。

--environment=environment​

または

ANYPOINT_ENV​ 環境変数

API がカタログ化されている Anypoint Platform 環境の名前。

--host=host

または

ANYPOINT_HOST​ 環境変数

デフォルト:

anypoint.mulesoft.com

プロトコルなしの Anypoint Platform ベース URL。

US Anypoint Platform の場合、次を使用します。

anypoint.mulesoft.com

ヨーロッパの Anypoint Platform の場合、次を使用します。

eu1.anypoint.mulesoft.com

--organization=organization​

または

ANYPOINT_ORG​ 環境変数

API がカタログ化されている Anypoint Platform 組織の ID。

-p, ​--password​

または

ANYPOINT_PASSWORD​ 環境変数

Anypoint ユーザーパスワード。

​「認証」​を参照してください。

-u, ​--username=username​

または

ANYPOINT_USERNAME​ 環境変数

Anypoint ユーザー名。

「認証」​を参照してください。

## [](#api-mgr-alert-add)api-mgr:alert:add \> api-mgr:alert:add \[flags\] このコマンドは、​``​ で渡される API インスタンス ID の ​`name`​ で渡される名前を使用して、API インスタンスアラートを作成します。 このコマンドでは、デフォルトの ​`--help`​ フラグ、一般フラグ、認証フラグ以外に次のフラグも受け入れます。
フラグ 説明

--duration <num>

条件が発生する期間。

--durationUnit <value>

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

--email <emailAddress>

アラート通知を送信するメール。
このフラグを複数回渡して、複数のメールを指定します。

--enabled

アラートを有効にするかどうかを設定する。アラートを有効にするフラグを含めます。

--operator <value>

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

--periods <num>

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

--policyId <num>

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

--recipient <username>

アラート通知を送信するユーザー名。
このフラグを複数回渡して、複数のユーザー名を指定します。

--responseCode <code>

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

--responseTime <num>

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

--severity <value>

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

--threshold <num>

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

--type <value>

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

このコマンドには複数オプションのフラグがあります。コマンドで複数オプションのフラグを使用する場合は、フラグの前にパラメーターを置くか、パラメーターの前に ​`-- `​ (2 つのダッシュの後にスペース) を使用します。
## [](#api-mgr-alert-list)api-mgr:alert:list \> api-mgr:alert:list \[flags\] ``​ で渡される API インスタンスのアラートをリストする。 このコマンドでは、デフォルトの ​`--help`​ フラグ、一般フラグ、認証フラグ以外に次のフラグも受け入れます。
フラグ 説明

--limit <value>

取得する結果の数 (デフォルトは 10)

--offset <value>

渡された API の数をオフセットする (例: --offset 3​)

--output <value>

応答形式を指定する
サポートされている値は、​table​ (デフォルト) および ​json​ です。

--sort

渡された項目名の結果を並び替える (例: --sort "Latest Version"​)

## [](#api-mgr-api-autodiscovery)api-mgr:api:autodiscovery \> api-mgr:api:autodiscovery \[flags\] このコマンドは、ゲートウェイが ​``​ で渡される API インスタンス ID を追跡するために必要な自動検出プロパティをリストします。 このコマンドでは、​`--help`​ フラグ、一般フラグ、認証フラグ以外に次のフラグも受け入れます。
フラグ 説明

--gatewayVersion

ダウンロードするゲートウェイバージョンを指定する
例: api-mgr:api:autodiscovery --gatewayVersion: 4.0.1 643404 /tmp/

--output <value>

応答形式を指定する
サポートされている値は、​table​ (デフォルト) および ​json​ です。

## [](#api-mgr-api-change-specification)api-mgr:api:change-specification \> api-mgr:api:change-specification \[flags\] ``​ で渡される Exchange の新しいバージョンを選択して、​``​ で渡される API インスタンスのアセットバージョンを変更します。 このコマンドでは、デフォルトのフラグ ​`--help`​、一般フラグ、認証フラグのみを受け入れます。 ## [](#api-mgr-api-classify)api-mgr:api:classify \> api-mgr:api:classify \[flags\] ``​ で渡される環境の ​``​ で渡される API インスタンスを分類します。 このコマンドでは、デフォルトのフラグ ​`--help`​、一般フラグ、認証フラグのみを受け入れます。 ## [](#api-mgr-api-delete)api-mgr:api:delete \> api-mgr:api:delete \[flags\] このコマンドは、​``​ で渡される API インスタンスを削除します。API インスタンスがデプロイされている場合、このコマンドは削除する前に API インスタンスのデプロイを解除します。 このコマンドでは、デフォルトのフラグ ​`--help`​、一般フラグ、認証フラグのみを受け入れます。 ## [](#api-mgr-api-deploy)api-mgr:api:deploy \> api-mgr:api:deploy \[flags\] このコマンドは、'' で渡される API インスタンスを下記のフラグを使用して指定されるデプロイメント対象にデプロイします。API Manager CLI と API Manger UI のどちらを使用して作成されたかに関係なく、このコマンドを使用して未デプロイの API をデプロイします。
このコマンドは、プロキシを持つエンドポイントでのみサポートされています。
このコマンドでは、デフォルトの ​`--help`​ フラグ、一般フラグ、認証フラグ以外に次のフラグも受け入れます。
フラグ 説明 例

--applicationName <name>

アプリケーション名

--applicationName myMuleApp 643404​

--environmentName <name>

対象環境名。未分類の環境から API インスタンスをデプロイする場合にのみ使用します。

--environmentName TestEnv 643404​

--gatewayVersion <version>

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

--gatewayVersion: 9.9.9.9 643404​

--overwrite

アプリケーションを更新する (存在する場合)

--overwrite: 643404​

--target <id>

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

--target 1598794 643404​

## [](#api-mgr-api-deprecate)api-mgr:api:deprecate \> api-mgr:api:deprecate \[flags\] ``​ で渡される API インスタンスを非推奨にします。 このコマンドでは、デフォルトのフラグ ​`--help`​、一般フラグ、認証フラグのみを受け入れます。 ## [](#api-mgr-api-describe)api-mgr:api:describe \> api-mgr:api:describe \[flags\] ``​ で渡される API インスタンスの詳細を表示します。 このコマンドでは、デフォルトの ​`--help`​ フラグ、一般フラグ、認証フラグ以外に、​`--output`​ フラグも使用できます。​`--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 ## [](#api-mgr-api-download-proxy)api-mgr:api:download-proxy \> api-mgr:api:download-proxy \[flags\] このコマンドは、​``​ で渡される API インスタンスの API プロキシ ZIP ファイルを ​``​ で指定されるローカルディレクトリにダウンロードします。Flex Gateway API インスタンスの API プロキシをダウンロードすることはできません。 このコマンドでは、デフォルトの ​`--help`​ フラグ、一般フラグ、認証フラグ以外に ​`gatewayVersion`​ フラグを使用して、ダウンロードするゲートウェイのバージョンを指定することもできます。 例: `api-mgr:api:download-proxy --gatewayVersion: 4.0.1 643404 /tmp/` ## [](#api-mgr-api-edit)api-mgr:api:edit \> api-mgr:api:edit \[flag\] このコマンドは、​``​ で渡される API インスタンスを編集します。デプロイされた Flex Gateway API インスタンスを編集すると、インスタンスが再デプロイされます。 このコマンドでは、デフォルトの ​`--help`​ フラグ、一般フラグ、認証フラグ以外に次のフラグも受け入れます。
フラグ 説明

-f, --isFlex

これが Flex Gateway API インスタンスであるかどうかを示す。
有効にするフラグを含めます。

-m, --muleVersion4OrAbove

これが Mule 4 API インスタンスであるかどうかを示す。
有効にするフラグを含めます。

-p, --withProxy

エンドポイントでプロキシを使用するかどうかを示す。
有効にするフラグを含めます。

-r, --referencesUserDomain

プロキシでユーザードメインを参照する必要があるかどうかを示す。
有効にするフラグを含めます。

--apiInstanceLabel <value>

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

--deploymentType <option>

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

--endpointUri <value>

コンシューマーエンドポイント URI。

--inboundSecretGroupId <value>

インバウンドシークレットグループ ID。

--inboundTlsContextId <value>

アウトバウンド TLS コンテキスト ID。
TLS コンテキストのシークレットグループの ​--inboundSecretGroupId​ を指定します。TLS コンテキストを削除するには、値が ​--inboundTlsContextId "null"​ のフラグを適用します。 TLS コンテキストを削除するには、値が ​--inboundTlsContextId "null"​ のフラグを適用します。

--outboundSecretGroupId <value>

アウトバウンドシークレットグループ ID。

--outboundTlsContextId <value>

アウトバウンド TLS コンテキスト ID。
TLS コンテキストのシークレットグループの ​--outboundSecretGroupId​ を指定します。TLS コンテキストを削除するには、値が ​outboundTlsContextId "null"​ のフラグを適用します。

--path <value>

プロキシパス。

--port <value>

プロキシポート。

--providerId <value>

API が関連付けられている省略可能なクライアント ID プロバイダー ID。デフォルトは、Anypoint Platform クライアントプロバイダーです。

--responseTimeout <value>

最大応答タイムアウト。

--scheme <value>

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

--serviceName <value>

WSDL サービス名。Flex Gateway ではこのフラグはサポートされていません。

--serviceNamespace <value>

WSDL サービス名前空間。Flex Gateway ではこのフラグはサポートされていません。

--servicePort <value>

WSDL サービスポート。Flex Gateway ではこのフラグはサポートされていません。

--updateApisInSamePort

この API のポートを共有する API インスタンスの TLS コンテキストを更新する。

--uri <value>

実装 URI。

## [](#api-mgr-api-list)api-mgr:api:list \> api-mgr:api:list \[flags\] API Manager 2.x のすべての API をリストします。 このコマンドでは、デフォルトの ​`--help`​ フラグ、一般フラグ、認証フラグ以外に次のフラグも受け入れます。
フラグ 説明

--apiVersion <value>​

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

--assetId <value>​

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

--instanceLabel <value>

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

--limit <num>​

取得する結果の数

--offset <value>

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

--sort

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

## [](#api-mgr-api-manage)api-mgr:api:manage \> api-mgr:api:manage \[flags\] ``​ で渡される Exchange アセット (​``​ で渡されるバージョン) を使用して、新しい API、API バージョン、新しい API インスタンスを管理します。 このコマンドでは、デフォルトの ​`--help`​ フラグ、一般フラグ、認証フラグ以外に次のフラグも受け入れます。
フラグ 説明

-f, --isFlex

これが Flex Gateway API インスタンスであるかどうかを示す。
有効にするフラグを含めます。Flex Gateway API インスタンスをデプロイする場合、このコマンドは ​--deploymentType​ オプションが ​hybrid​ であると想定します。

-m, --muleVersion4OrAbove

この API インスタンスが Mule 4 以降で管理されているかどうかを示す。
有効にするフラグを含めます。

-p, --withProxy

エンドポイントでプロキシを使用するかどうかを示す。
有効にするフラグを含めます。

-r, --referencesUserDomain

プロキシでユーザードメインを参照する必要があるかどうかを示す。
有効にするフラグを含めます。

--apiInstanceLabel <value>

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

--deploymentType <option>

デプロイメント種別。
サポートされている値は、​cloudhub​、​hybrid​、​rtf​ です。Flex Gateway API インスタンスをデプロイする場合、このコマンドは ​--deploymentType​ オプションが ​hybrid​ であると想定します。

--endpointUri <value>

コンシューマーエンドポイント URI。

--inboundSecretGroupId <value>

インバウンドシークレットグループ ID。

--inboundTlsContextId <value>

アウトバウンド TLS コンテキスト ID。
TLS コンテキストのシークレットグループの ​--inboundSecretGroupId​ を指定します。

--outboundSecretGroupId <value>

アウトバウンドシークレットグループ ID。

--outboundTlsContextId <value>

アウトバウンド TLS コンテキスト ID。
TLS コンテキストのシークレットグループの ​--outboundSecretGroupId​ を指定します。

--path <value>

プロキシパス。

--port <value>

プロキシポート。

--providerId <value>

API が関連付けられている省略可能なクライアント ID プロバイダー ID。デフォルトは、Anypoint Platform クライアントプロバイダーです。

--responseTimeout <value>

応答タイムアウト。

--scheme <value>

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

--serviceName <value>

WSDL サービス名。Flex Gateway ではこのフラグはサポートされていません。

--serviceNamespace <value>

WSDL サービス名前空間。Flex Gateway ではこのフラグはサポートされていません。

--servicePort <value>

WSDL サービスポート。Flex Gateway ではこのフラグはサポートされていません。

--type <option>

エンドポイント種別。サポートされているオプションは、​http​、​raml​、および ​wsdl​ です。

--uri <value>

実装 URI。

## [](#api-mgr-api-promote)api-mgr:api:promote \> api-mgr:api:promote \[flags\] ``​ で渡される昇格元環境の ​``​ で渡される API インスタンスを昇格します。 このコマンドでは、デフォルトの ​`--help`​ フラグ、一般フラグ、認証フラグ以外に次のフラグも受け入れます。
フラグ 説明

-a, --copyAlerts

アラートをコピーするかどうかを示す。
有効にするフラグを含めます。

-p, --copyPolicies

ポリシーをコピーするかどうかを示す。
有効にするフラグを含めます。

-t, --copyTiers

層をコピーするかどうかを示す。
有効にするフラグを含めます。

-providerId

API に関連付けられたプロバイダーの ID を示す。

## [](#api-mgr-api-redeploy)api-mgr:api:redeploy \> api-mgr:api:redeploy \[flags\] ``​ で渡される API インスタンスを下記のフラグでセットアップされるデプロイメント対象に再デプロイします。 このコマンドでは、デフォルトの ​`--help`​ フラグ、一般フラグ、認証フラグ以外に次のフラグも受け入れます。
フラグ 説明

--applicationName <name>

アプリケーション名

--environmentName <name>

対象環境名
未分類の環境から API を再デプロイする場合に含めます

--gatewayVersion <version>

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

--overwrite

アプリケーションを更新する (存在する場合)
有効にするフラグを含めます

--target <id>

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

## [](#api-mgr-api-undeprecate)api-mgr:api:undeprecate \> api-mgr:api:undeprecate \[flags\] ``​ で渡される API インスタンスの非推奨を解除します。 このコマンドでは、デフォルトのフラグ ​`--help`​、一般フラグ、認証フラグのみを受け入れます。 ## [](#api-mgr-contract-delete)api-mgr:contract:delete \> api-mgr:contract:delete \[flags\] このコマンドは、​``​ で渡される API インスタンスと ​``​ で渡されるクライアント間のコントラクトを削除します。 このコマンドでは、デフォルトのフラグ ​`--help`​、一般フラグ、認証フラグのみを受け入れます。 ## [](#api-mgr-contract-list)api-mgr:contract:list \> api-mgr:contract:list \[flags\] \[searchText\] ``​ で渡される API のすべてのコントラクトをリストします。
searchText でキーワードを指定して、それらの特定のキーワードが含まれる API のみが結果に表示されるように制限できます。
このコマンドでは、デフォルトの ​`--help`​ フラグ、一般フラグ、認証フラグ以外に次のフラグも受け入れます。
フラグ 説明 例

--limit <value>

取得する結果の数

--limit 2

--offset <value>

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

--offset 3

--output <value>

応答形式を指定する。サポートされている値は、​table​ (デフォルト) および ​json​ です

--output json

--sort <value>

クライアントアプリケーションに関連付けられた条件によってコントラクトを並べ替える。サポートされている値は、​createdDate​、​id​、​name​ です

--sort id

## [](#api-mgr-policy-apply)api-mgr:policy:apply \> api-mgr:policy:apply \[flags\] ``​ で渡されるポリシーを ​``​ で渡される API インスタンスに適用します。 このコマンドでは、デフォルトの ​`--help`​ フラグ、一般フラグ、認証フラグ以外に次のフラグも受け入れます。
フラグ 説明

-c, --config [configJSON]

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

--configFile [file]

設定データをファイルとして渡す。
例: api-mgr policy apply --configFile ./config.json​。

--groupId <value>

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

-p, --pointcut [dataJSON]

ポイントカットデータを JSON 文字列として渡す。
例: api-mgr:policy:apply (…​) -p '[{"methodRegex":"GET|PUT","uriTemplateRegex":"/users*"}]'.

--policyVersion <value>

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

次の例では、レート制限を 10 秒ごとに 1 件の要求として定義しています。 { "rateLimits": \[{ "maximumRequests": 1, "timePeriodInMilliseconds": 10000 }\], "clusterizable": true, "exposeHeaders": false } ## [](#api-mgr-policy-describe)api-mgr:policy:describe \> api-mgr:policy:describe \[flags\] このコマンドは、​``​ で渡されるポリシーの情報と使用可能な設定プロパティを表示します。 このコマンドでは、デフォルトの ​`--help`​ フラグ、一般フラグ、認証フラグ以外に次のフラグも受け入れます。
フラグ 説明

--groupId <value>

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

--policyVersion <value>

Mule 4 ポリシーバージョン

--output <value>

応答形式を指定する
サポートされている値は、​table​ (デフォルト) および ​json​ です。

## [](#api-mgr-policy-disable)api-mgr:policy:disable \> api-mgr:policy:disable \[flags\] このコマンドは、​``​ で渡される API インスタンスの ​``​ で渡されるポリシーを無効にします。 このコマンドでは、デフォルトのフラグ ​`--help`​、一般フラグ、認証フラグのみを受け入れます。 ## [](#api-mgr-policy-edit)api-mgr:policy:edit \> api-mgr:policy:edit \[flags\] このコマンドは、​``​ で渡される API インスタンスの ​``​ で渡されるポリシー設定を編集します。 このコマンドでは、デフォルトの ​`--help`​ フラグ、一般フラグ、認証フラグ以外に次のフラグも受け入れます。
フラグ 説明

-c, --config [configJSON​]

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

-p, --pointcut [dataJSON]

ポイントカットデータを JSON 文字列として渡す
例: api-mgr:policy:apply (…​) -p '[{"methodRegex":"GET|PUT","uriTemplateRegex":"/users*"}]'

## [](#api-mgr-policy-enable)api-mgr:policy:enable \> api-mgr:policy:enable \[flags\] このコマンドは、​``​ で渡される API インスタンスの ​``​ で渡されるポリシーを有効にします。 このコマンドでは、デフォルトのフラグ ​`--help`​、一般フラグ、認証フラグのみを受け入れます。 ## [](#api-mgr-policy-list)api-mgr:policy:list \> api-mgr:policy:list \[flags\] \[apiInstanceId\] このコマンドは、API Manager 2.x のすべての API の全ポリシーをリストします。 `[apiInstanceId]`​ フラグが指定されると、このコマンドはその API インスタンスに適用されるポリシーをリストします。​`[apiInstanceId]`​ を指定しないと、すべての API のすべてのポリシーがリストされます。 このコマンドは、デフォルトの ​`--help`​ フラグ、一般フラグ、認証フラグ以外に、​`-m, --muleVersion4OrAbove`​ フラグも受け入れます。 ## [](#api-mgr-policy-remove)api-mgr:policy:remove \> api-mgr:policy:remove \[flags\] このコマンドは、​``​ で渡される API インスタンスから ​``​ で指定されるポリシーを削除します。 このコマンドでは、デフォルトのフラグ ​`--help`​、一般フラグ、認証フラグのみを受け入れます。 ## [](#api-mgr-tier-add)api-mgr:tier:add \> api-mgr:tier:add \[flags\] このコマンドは、​``​ で渡される API インスタンスの SLA 層を作成します。 このコマンドでは、デフォルトの ​`--help`​ フラグ、一般フラグ、認証フラグ以外に次のフラグも受け入れます。
フラグ 説明

-a, --autoApprove

SLA 層を自動承認する必要があるかどうかを示す。
有効にするフラグを含めます。

--name <value>

層の名前。

--description <value>

層の情報。

-l, --limit <value>

--limit A,B,C​ 形式の SLA 層の制限の単一インスタンス。

  • A​ はこの制限がユーザーに表示されるかどうかを示すブール。

  • B​ は「C」期間ごとの要求数。

  • C​ は期間の単位。期間のオプションは、次のとおりです。

    • ms​ (ミリ秒)

    • sec​ (秒)

    • min​ (分)

    • hr​ (時間)

    • d​ (日)

    • wk​ (週)

    • mo​ (月)

    • yr​ (年)

例: --limit true,100,min​ は、100 要求/分の制限 (visible) です。

複数の制限を作成するために、複数の ​--limit​ オプションを指定できます。
例: -l true,100,sec -l false,20,min​。
## [](#api-mgr-tier-copy)api-mgr:tier:copy \> api-mgr:tier:copy \[flags\] このコマンドは、​``​ で渡される API インスタンスから ​``​ で渡される API インスタンス ID に SLA 層をコピーします。 このコマンドでは、デフォルトのフラグ ​`--help`​、一般フラグ、認証フラグのみを受け入れます。 ## [](#api-mgr-tier-delete)api-mgr:tier:delete \> api-mgr:tier:delete \[flags\] このコマンドは、​``​ で渡される API インスタンスから ​``​ で渡される SLA 層を削除します。 このコマンドでは、デフォルトのフラグ ​`--help`​、一般フラグ、認証フラグのみを受け入れます。 ## [](#api-mgr-tier-list)api-mgr:tier:list \> api-mgr:tier:list \[flags\] \[searchText\] このコマンドは、​``​ で渡される API インスタンスの SLA 層をリストします。 このコマンドでは、デフォルトの ​`--help`​ フラグ、一般フラグ、認証フラグ以外に次のフラグも受け入れます。
フラグ 説明 例

--limit

取得する結果の数

--limit 2

--offset

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

--offset 3

--output <value>

応答形式を指定する。サポートされている値は、​table​ (デフォルト) および ​json​ です

--output json

--sort

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

--sort "Latest Version"

# CloudHub 2.0 の CLI これらのコマンドを使用して、Cloudhub 2.0 のアプリケーションでアプリケーションをデプロイおよび管理します。
コマンド 説明

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

Exchange アプリケーションを使用して指定された対象にアプリケーションをデプロイし、指定されたランタイムバージョンを実行する

アプリケーションの情報を表示する

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

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

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

デプロイ済みのアプリケーションを修正する

停止中のアプリケーションを開始する

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

仕様のアプリケーションのログを追跡する

## [](#runtime-mgr-application-delete)runtime-mgr application delete \> runtime-mgr application delete \[options\] ``​ で指定された実行中のアプリケーションを削除します。この ID を取得するには、​`runtime-mgr application list`​ コマンドを実行します。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-application-deploy)runtime-mgr application deploy \> runtime-mgr application deploy \[options\] ``​ で指定されたアプリケーションを、次のオプションを使用して指定されたデプロイメント対象にデプロイします。
値 説明 例

ArtifactId

Exchange から取得したアプリケーションのアーティファクト ID。

mule-test-plugin

deploymentTargetID

デプロイメント対象の ID。
この ID は、Runtime Manager から直接取得できます。

app.runetime

name

デプロイするアプリケーションの名前。

testCloudhub2app

runtimeVersion

デプロイメント対象のランタイムバージョン。

1.0.1​

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

assetVersion

使用する Exchange アプリケーションのバージョン。
デフォルト: 最新のアプリケーションバージョン

2.0.4

clustered

クラスタリングされたノードを有効にします。少なくとも 2 つのレプリカが必要です。
デフォルト:.disabled
サポートされている値: true​、​false

false

disableAmLogForwarding

Anypoint Monitoring へのアプリケーションログの転送を無効にします。
デフォルト: enabled
サポートされている値: true​、​false

true

forwardSslSession

SSL セッション転送を有効にします。
デフォルト: disabled
値: true​、​false

false

groupId

デプロイするアセットの ID。
デフォルト: 選択済み組織 ID

org.mule.test

lastMileSecurity

Last Mile セキュリティを有効にします。
デフォルト: disabled
サポートされている値: true​、​false

true

objectStoreV2

Object Store v2 を有効にします。
デフォルト: disabled
サポートされている値: true​、​false

true

pathRewrite

アプリケーションの HTTP リスナーで要求されるベースパスを提供します。
形式: /​ で始まる必要があります

/http://localhost:3000

property

プロパティを設定します。
形式: name:value

testproperty:true

propertiesFile

すべてのプロパティを選択済みファイルの値に置き換えます。
形式: 1 行以上の ​name:value​ 形式

/Users/mule/Documents/properties.txt

publicEndpoints

公開インターネット経由で到達するエンドポイントを提供します。
形式: カンマ区切りでスペースなし

my-superapp-example:/status?limit=10

replicas

レプリカの数。​0​ より大きい必要があります。
デフォルト: 1

2

replicaSize

vCore のレプリカのサイズ。
デフォルト: 0.1

0.5

scopeLoggingConfig

スコープログ記録を定義します。
形式: scopeName: logLevel​、カンマ区切りでスペースなし

testscope1:WARN,testscope2:DEBUG

scopeLoggingConfigFile

ファイルをアップロードしてスコープログ記録を定義します。
形式: 1 行に 1 タプル、スタイル: {scope: scopeName, logLevel: logLevelType}​ を ​{} ​()​ または ​[]​ で囲む

/Users/mule/Documents/cert.txt

updateStrategy

使用される戦略を更新します。
デフォルト: rolling

recreate

## [](#runtime-mgr-application-describe)runtime-mgr application describe \> runtime-mgr application describe \[options\] ``​ で指定されたアプリケーションに関する情報を表示します。この ID を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-application-describe-json)runtime-mgr application describe-json \> runtime-mgr application describe-json \[options\] ``​ で指定されたアプリケーションから未加工の JSON 応答を表示します。この ID を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-application-download-logs)runtime-mgr application download-logs \> runtime-mgr application download-logs \[options\] ``​ で指定された仕様から、選択したディレクトリに ​``​ で指定されたアプリケーションのログをダウンロードします。 ``​ を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 ``​ を取得するには、​`runtime-mgr application describe`​ コマンドを実行します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-application-list)runtime-mgr application list \> runtime-mgr application list \[options\] 組織内のすべてのアプリケーションをリストします。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-application-modify)runtime-mgr application modify \> runtime-mgr application modify \[options\] ``​ で指定された既存のアプリケーションの設定を更新します。 ``​ を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 このコマンドでは、デフォルトの ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ オプション以外に次のオプションも使用できます。
値 説明 例

ArtifactId

Exchange から取得したアプリケーションの ID。

mule-maven-plugin

assetVersion

使用する Exchange アプリケーションのバージョン。
デフォルト: 最新のアプリケーションバージョン

2.0.4

clustered

クラスタリングされたノードを有効にします。少なくとも 2 つのレプリカが必要です。
デフォルト: disabled
サポートされている値: true​、​false

false

disableAmLogForwarding

Anypoint Monitoring へのアプリケーションログの転送を無効にします。
デフォルト: enabled
サポートされている値: true​、​false

true

forwardSslSession

SSL セッション転送を有効にします。
デフォルト: disabled
値: true​、​false

false

groupId

デプロイするアセットの ID。
デフォルト: 選択済み組織 ID。

org.mule.testgroup

lastMileSecurity

Last Mile セキュリティを有効にします。
デフォルト: disabled
サポートされている値: true​、​false

true

objectStoreV2

Object Store v2 を有効にします。
デフォルト: disabled
サポートされている値: true​、​false

true

pathRewrite

アプリケーションの HTTP リスナーで要求されるベースパスを提供します。
形式: /​ で始まる必要があります

/http://localhost:3000​.

property

プロパティを設定します。
形式: name:value

testproperty:true

propertiesFile

すべてのプロパティを選択済みファイルの値に置き換えます。
形式: 1 行以上の ​name:value​ 形式

/Users/mule/Documents/properties.txt

publicEndpoints

公開インターネット経由で到達するエンドポイントを提供します。
形式: カンマ区切りでスペースなし

my-superapp-example: /status?limit=10

replicas

レプリカの数。​0​ より大きい必要があります。
デフォルト: 1

2

replicaSize

vCore のレプリカのサイズ。
デフォルト: 0.1

0.5

runtimeVersion

デプロイメント対象のランタイムバージョン。

1.0.1

scopeLoggingConfig

スコープログ記録を定義します。
形式: scopeName: logLevel​、カンマ区切りでスペースなし

testscope1:WARN,testscope2:DEBUG

scopeLoggingConfigFile

ファイルをアップロードしてスコープログ記録を定義します。
形式: 1 行に 1 タプル、スタイル: {scope: scopeName, logLevel: logLevelType}​ を ​{} ​()​ または ​[]​ で囲む

/Users/mule/Documents/cert.txt

updateStrategy

使用される戦略を更新します。
デフォルト: rolling

recreate​

## [](#runtime-mgr-application-start)runtime-mgr application start \> runtime-mgr application start \[options\] ``​ で指定されたアプリケーションの実行を開始します。この ID を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 このコマンドでは、デフォルトのオプション ​`--help`​ のみを受け入れます。 ## [](#runtime-mgr-application-stop)runtime-mgr application stop \> runtime-mgr application stop \[options\] ``​ で指定されたアプリケーションの実行を停止します。この ID を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 このコマンドでは、デフォルトのオプション ​`--help`​ のみを受け入れます。 ## [](#runtime-mgr-application-tail-logs)runtime-mgr application tail-logs \> runtime-mgr:application:tail-logs \[options\] ``​ で指定された仕様から、​``​ で指定されたアプリケーションのアプリケーションログを追跡します。 ``​ を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 ``​ を取得するには、​`runtime-mgr application describe`​ コマンドを実行します。 このコマンドでは、デフォルトのオプション ​`--help`​ のみを受け入れます。 # CloudHub 2.0 の CLI これらのコマンドを使用して、Cloudhub 2.0 のアプリケーションでアプリケーションをデプロイおよび管理します。
コマンド 説明

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

アプリケーションの情報を表示する

Exchange アプリケーションを使用して指定された対象にアプリケーションをデプロイし、指定されたランタイムバージョンを実行する

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

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

デプロイ済みのアプリケーションを修正する

停止中のアプリケーションを開始する

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

仕様のアプリケーションのログを追跡する

## [](#runtime-mgr-application-delete)runtime-mgr:application:delete \> runtime-mgr:application:delete \[flags\] ``​ で指定された実行中のアプリケーションを削除します。この ID を取得するには、​`runtime-mgr application list`​ コマンドを実行します。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgr-application-describe)runtime-mgr:application:describe \> runtime-mgr:application:describe \[flags\] ``​ で指定されたアプリケーションに関する情報を表示します。この ID を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 このコマンドには ​`--output`​ フラグを使用できます。​`--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 このコマンドでは、デフォルトのフラグ ​`--help`​ も受け入れます。 ## [](#runtime-mgr-application-deploy)runtime-mgr:application:deploy \> runtime-mgr:application:deploy \[flags\] ``​ で指定されたアプリケーションを、次のオプションを使用して指定されたデプロイメント対象にデプロイします。
値 説明 例

--artifactId

Exchange から取得したアプリケーションのアーティファクト ID。

--artifactId mule-test-plugin

--deploymentTargetId

デプロイメント対象の ID。
この ID は、Runtime Manager から直接取得できます。

--deploymentTargetId 7de39400-a2b3-0a93-b2349-23eacbca9e322

--name

デプロイするアプリケーションの名前。

--name testcloudhub2app

--runtimeVersion

デプロイメント対象のランタイムバージョン。

--runtimeVersion 4.4.0

--secureProperty

暗号化されたプロパティを設定します。

--secureProperty secureTestProperty:true​

このコマンドでは、デフォルトの ​`--help`​ フラグ以外に次のフラグも使用できます。
フラグ 説明 例

--assetVersion

使用する Exchange アプリケーションのバージョン。
デフォルト: 最新のアプリケーションバージョン

--assetVersion 2.0.4

--[no-]clustered

クラスタリングされたノードを有効にします。少なくとも 2 つのレプリカが必要です。
デフォルト:.disabled

--no-clustered

--[no-]disableAmLogForwarding

Anypoint Monitoring へのアプリケーションログの転送を無効にします。
デフォルト: enabled

--disableAmLogForwarding

--[no-]forwardSslSession

SSL セッション転送を有効にします。
デフォルト: disabled

--no-forwardSslSession

--groupId

デプロイするアセットの ID。
デフォルト: 選択済み組織 ID

--groupId org.mule.test

--[no-]lastMileSecurity

Last Mile セキュリティを有効にします。
デフォルト: disabled

--no-lastMileSecurity

--[no-]objectStoreV2

Object Store v2 を有効にします。
デフォルト: disabled

--no-objectStoreV2

--pathRewrite

アプリケーションの HTTP リスナーで要求されるベースパスを提供します。
形式: /​ で始まる必要があります

--pathRewrite /http://localhost:3000

--property

プロパティを設定します。
形式: name:value

--property testproperty:true

--propertiesFile

すべてのプロパティを選択済みファイルの値に置き換えます。
形式: 1 行以上の ​name:value​ 形式

--propertiesFile /Users/mule/Documents/properties.txt

--publicEndpoints

公開インターネット経由で到達するエンドポイントを提供します。
形式: カンマ区切りでスペースなし

--publicEndpoints my-superapp-example:/status?limit=10

--replicas

レプリカの数。​0​ より大きい必要があります。
デフォルト: 1

--replicas 2

--replicaSize

vCore のレプリカのサイズ。
デフォルト: 0.1

--replicaSize 0.5

--scopeLoggingConfig

スコープログ記録を定義します。
形式: scopeName: logLevel​、カンマ区切りでスペースなし

--scopeLoggingConfig testscope1:WARN,testscope2:DEBUG

--scopeLoggingConfigFile

ファイルをアップロードしてスコープログ記録を定義します。
形式: 1 行に 1 タプル、スタイル: {scope: scopeName, logLevel: logLevelType}​ を ​{} ​()​ または ​[]​ で囲む

--scopeLoggingConfigFile /Users/mule/Documents/cert.txt

--updateStrategy

使用される戦略を更新します。
デフォルト: rolling

--updateStrategy recreate

このコマンドには複数オプションのフラグがあります。コマンドで複数オプションのフラグを使用する場合は、フラグの前にパラメーターを置くか、パラメーターの前に ​`-- `​ (2 つのダッシュの後にスペース) を使用します。

Mule 4.5 以降、MuleSoft は Edge と長期サポート (LTS) という 2 つの新しいリリースチャネルを導入します。新しいリリースチャネルの Mule Runtime バージョン設定スキーマは次のとおりです。

メジャー[数値] .マイナー[数値] . パッチ[数値] : ビルド[数値] チャネル[Edge の場合は e、LTS の場合はなし]

これらの値の例としては、Edge の場合は ​4.5.0:1e​、LTS の場合は ​4.6.0:1​ となります。

詳細は、Edge and LTS Releases for Muleを参照してください。

## [](#runtime-mgr-application-download-logs)runtime-mgr:application:download-logs \> runtime-mgr:application:download-logs \[flags\] ``​ で指定された仕様から、選択したディレクトリに ​``​ で指定されたアプリケーションのログをダウンロードします。 ``​ を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 ``​ を取得するには、​`runtime-mgr application describe`​ コマンドを実行します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgr-application-list)runtime-mgr:application:list \> runtime-mgr:application:list \[flags\] 組織内のすべてのアプリケーションをリストします。 このコマンドには ​`--output`​ フラグを使用できます。​`--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 このコマンドでは、デフォルトのフラグ ​`--help`​ を受け入れます。 ## [](#runtime-mgr-application-modify)runtime-mgr:application:modify \> runtime-mgr:application:modify \[flags\] ``​ で指定された既存のアプリケーションの設定を更新します。 ``​ を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 このコマンドでは、デフォルトの ​`--help`​ フラグ以外に次のフラグも使用できます。
フラグ 説明 例

--artifactId

Exchange から取得したアプリケーションの ID。

--artifactId mule-maven-plugin

--assetVersion

使用する Exchange アプリケーションのバージョン。
デフォルト: 最新のアプリケーションバージョン

--assetVersion 2.0.4

--[no-]clustered

クラスタリングされたノードを有効にします。少なくとも 2 つのレプリカが必要です。
デフォルト: disabled

--no-clustered

--[no-]disableAmLogForwarding

Anypoint Monitoring へのアプリケーションログの転送を無効にします。
デフォルト: enabled

--disableAmLogForwarding

--[no-]forwardSslSession

SSL セッション転送を有効にします。
デフォルト: disabled

--no-forwardSslSession

--groupId

デプロイするアセットの ID。
デフォルト: 選択済み組織 ID。

--groupId org.mule.testgroup

--[no-]lastMileSecurity

Last Mile セキュリティを有効にします。
デフォルト: disabled

--no-lastMileSecurity

--[no-]objectStoreV2

Object Store v2 を有効にします。
デフォルト: disabled

--no-objectStoreV2

--pathRewrite

アプリケーションの HTTP リスナーで要求されるベースパスを提供します。
形式: /​ で始まる必要があります

--pathRewrite /http://localhost:3000​。

--property

プロパティを設定します。
形式: name:value

--property testproperty:true

--propertiesFile

すべてのプロパティを選択済みファイルの値に置き換えます。
形式: 1 行以上の ​name:value​ 形式

--propertiesFile /Users/mule/Documents/properties.txt

--publicEndpoints

公開インターネット経由で到達するエンドポイントを提供します。
形式: カンマ区切りでスペースなし

--publicEndpoints my-superapp-example: /status?limit=10

--replicas

レプリカの数。​0​ より大きい必要があります。
デフォルト: 1

--replicas 2

--replicaSize

vCore のレプリカのサイズ。
デフォルト: 0.1

--replicaSize 0.5

--runtimeVersion

デプロイメント対象のランタイムバージョン。

--runtimeVersion 4.4.0

--secureProperty

暗号化されたプロパティを設定します。

--secureProperty secureTestProperty:true

--scopeLoggingConfig

スコープログ記録を定義します。
形式: scopeName: logLevel​、カンマ区切りでスペースなし

--scopeLoggingConfig testscope1:WARN,testscope2:DEBUG

--scopeLoggingConfigFile

ファイルをアップロードしてスコープログ記録を定義します。
形式: 1 行に 1 タプル、スタイル: {scope: scopeName, logLevel: logLevelType}​ を ​{} ​()​ または ​[]​ で囲む

--scopeLoggingConfigFile /Users/mule/Documents/cert.txt

--updateStrategy

使用される戦略を更新します。
デフォルト: rolling

--updateStrategy recreate​

このコマンドには複数オプションのフラグがあります。コマンドで複数オプションのフラグを使用する場合は、フラグの前にパラメーターを置くか、パラメーターの前に ​`-- `​ (2 つのダッシュの後にスペース) を使用します。
## [](#runtime-mgr-application-start)runtime-mgr:application:start \> runtime-mgr:application:start \[flags\] ``​ で指定されたアプリケーションの実行を開始します。この ID を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgr-application-stop)runtime-mgr:application:stop \> runtime-mgr:application:stop \[flags\] ``​ で指定されたアプリケーションの実行を停止します。この ID を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgr-application-logs)runtime-mgr:application:logs \> runtime-mgr:application:logs \[flags\] ``​ で指定された仕様から、​``​ で指定されたアプリケーションのアプリケーションログを追跡します。 ``​ を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 ``​ を取得するには、​`runtime-mgr application describe`​ コマンドを実行します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgrapplicationdelete)runtime-mgr:application:delete \> runtime-mgr:application:delete \[flags\] ``​ で指定された実行中のアプリケーションを削除します。この ID を取得するには、​`runtime-mgr application list`​ コマンドを実行します。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgrapplicationdescribe)runtime-mgr:application:describe \> runtime-mgr:application:describe \[flags\] ``​ で指定されたアプリケーションに関する情報を表示します。この ID を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgrapplicationdownload-logs)runtime-mgr:application:download-logs \> runtime-mgr:application:download-logs \[flags\] ``​ で指定された仕様から、選択したディレクトリに ​``​ で指定されたアプリケーションのログをダウンロードします。 ``​ を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 ``​ を取得するには、​`runtime-mgr application describe`​ コマンドを実行します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgrapplicationlist)runtime-mgr:application:list \> runtime-mgr:application:list \[flags\] 組織内のすべてのアプリケーションをリストします。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgrapplicationmodify)runtime-mgr:application:modify \> runtime-mgr application modify \[flags\] ``​ で指定された既存のアプリケーションの設定を更新します。 ``​ を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 このコマンドでは、デフォルトの ​`--help`​ フラグ以外に次のフラグも使用できます。
フラグ 説明 例

--artifactId

Exchange から取得したアプリケーションの ID。

--artifactId mule-maven-plugin

--assetVersion

使用する Exchange アプリケーションのバージョン。
デフォルト: 最新のアプリケーションバージョン

-assetVersion 2.0.4

--[no-]clustered

クラスタリングされたノードを有効にします。少なくとも 2 つのレプリカが必要です。
デフォルト: disabled

--no-clustered

--[no-]disableAmLogForwarding

Anypoint Monitoring へのアプリケーションログの転送を無効にします。
デフォルト: enabled

--disableAmLogForwarding

--[no-]forwardSslSession

SSL セッション転送を有効にします。
デフォルト: disabled

--no-forwardSslSession

--groupId

デプロイするアセットの ID。
デフォルト: 選択済み組織 ID。

-groupId org.mule.testgroup

--[no-]lastMileSecurity

Last Mile セキュリティを有効にします。
デフォルト: disabled

--no-lastMileSecurity

--[no-]objectStoreV2

Object Store v2 を有効にします。
デフォルト: disabled

--no-objectStoreV2

--pathRewrite

アプリケーションの HTTP リスナーで要求されるベースパスを提供します。
形式: /​ で始まる必要があります

--pathRewrite /http://localhost:3000​。

--property

プロパティを設定します。
形式: name:value

--property testproperty:true

--propertiesFile

すべてのプロパティを選択済みファイルの値に置き換えます。
形式: 1 行以上の ​name:value​ 形式

--propertiesFile /Users/mule/Documents/properties.txt

--publicEndpoints

公開インターネット経由で到達するエンドポイントを提供します。
形式: カンマ区切りでスペースなし

--publicEndpoints my-superapp-example: /status?limit=10

--replicas

レプリカの数。​0​ より大きい必要があります。
デフォルト: 1

--replicas 2

--replicaSize

vCore のレプリカのサイズ。
デフォルト: 0.1

--replicaSize 0.5

--runtimeVersion

デプロイメント対象のランタイムバージョン。

--runtimeVersion 1.0.1

--scopeLoggingConfig

スコープログ記録を定義します。
形式: scopeName: logLevel​、カンマ区切りでスペースなし

--scopeLoggingConfig testscope1:WARN,testscope2:DEBUG

--scopeLoggingConfigFile

ファイルをアップロードしてスコープログ記録を定義します。
形式: 1 行に 1 タプル、スタイル: {scope: scopeName, logLevel: logLevelType}​ を ​{} ​()​ または ​[]​ で囲む

--scopeLoggingConfigFile /Users/mule/Documents/cert.txt

--updateStrategy

使用される戦略を更新します。
デフォルト: rolling

--updateStrategy recreate​

## [](#runtime-mgrapplicationstart)runtime-mgr:application:start \> runtime-mgr:application:start \[flags\] ``​ で指定されたアプリケーションの実行を開始します。この ID を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgrapplicationstop)runtime-mgr:application:stop \> runtime-mgr:application:stop \[flags\] ``​ で指定されたアプリケーションの実行を停止します。この ID を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgrapplicationlogs)runtime-mgr:application:logs \> runtime-mgr:application:logs \[flags\] ``​ で指定された仕様から、​``​ で指定されたアプリケーションのアプリケーションログを追跡します。 ``​ を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 ``​ を取得するには、​`runtime-mgr application describe`​ コマンドを実行します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 # CloudHub アプリケーションの CLI
コマンド 説明

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

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

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

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

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

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

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

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

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

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

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

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

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

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

## [](#runtime-mgr-cloudhub-alert-list)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 \> runtime-mgr cloudhub-alert-history describe \[options\] このコマンドは、​``​ で渡されるアラームの履歴の情報を表示します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-cloudhub-application-list)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 \> runtime-mgr cloudhub-application describe \[options\] このコマンドは、​``​ で渡すアプリケーションに関する情報を表示します。 アプリケーションの名前の入力を開始して ​`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 \> runtime-mgr cloudhub-application describe-json \[options\] このコマンドは、​``​ で指定するアプリケーションの未加工の JSON 応答を返します。 アプリケーションの名前の入力を開始して ​`tab`​ キーを押すと、Anypoint Platform CLI によって名前がオートコンプリートされます。また、​`tab`​ キーをダブルタップすると、渡すことができるすべての値の完全なリストが表示されます。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-cloudhub-application-stop)runtime-mgr cloudhub-application stop \> runtime-mgr cloudhub-application stop \[options\] このコマンドは、​``​ で指定する実行中のアプリケーションを停止します。 アプリケーションの名前の入力を開始して ​`tab`​ キーを押すと、Anypoint Platform CLI によって名前がオートコンプリートされます。また、​`tab`​ キーをダブルタップすると、渡すことができるすべての値の完全なリストが表示されます。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-cloudhub-application-start)runtime-mgr cloudhub-application start \> runtime-mgr cloudhub-application start \[options\] このコマンドは、​``​ で指定する実行中のアプリケーションを開始します。 アプリケーションの名前の入力を開始して ​`tab`​ キーを押すと、Anypoint Platform CLI によって名前がオートコンプリートされます。また、​`tab`​ キーをダブルタップすると、渡すことができるすべての値の完全なリストが表示されます。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-cloudhub-application-restart)runtime-mgr cloudhub-application restart \> runtime-mgr cloudhub-application restart \[options\] このコマンドは、​``​ で指定する実行中のアプリケーションを再起動します。 アプリケーションの名前の入力を開始して ​`tab`​ キーを押すと、Anypoint Platform CLI によって名前がオートコンプリートされます。また、​`tab`​ キーをダブルタップすると、渡すことができるすべての値の完全なリストが表示されます。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-cloudhub-application-delete)runtime-mgr cloudhub-application delete \> runtime-mgr cloudhub-application delete \[options\] このコマンドは、​``​ で指定する実行中のアプリケーションを削除します。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#deploy-to-cloudhub)runtime-mgr cloudhub-application deploy \> runtime-mgr cloudhub-application deploy \[options\] このコマンドは、​``​ で設定する名前を使用して、​``​ で指定する 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 --runtime \[tab\]\[tab\] 選択できる使用可能なすべてのランタイムをリストします。

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

## [](#runtime-mgr-cloudhub-application-modify)runtime-mgr cloudhub-application modify \> runtime-mgr cloudhub-application modify \[options\] \[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 \> runtime-mgr cloudhub-application download-logs \[options\] このコマンドは、​``​ で指定されるアプリケーションのログを指定のディレクトリにダウンロードします。 アプリケーションの名前の入力を開始して ​`tab`​ キーを押すと、Anypoint Platform CLI によって名前がオートコンプリートされます。また、​`tab`​ キーをダブルタップすると、渡すことができるすべての値の完全なリストが表示されます。 UI とは異なり、CLI からダウンロードするログでは、システムログとワーカーログが分離されません。 ## [](#runtime-mgr-cloudhub-application-tail-logs)runtime-mgr cloudhub-application tail-logs \> runtime-mgr cloudhub-application tail-logs \[options\] このコマンドは、アプリケーションログの末尾を表示します。 アプリケーションの名前の入力を開始して ​`tab`​ キーを押すと、Anypoint Platform CLI によって名前がオートコンプリートされます。また、​`tab`​ キーをダブルタップすると、渡すことができるすべての値の完全なリストが表示されます。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-cloudhub-application-copy)runtime-mgr cloudhub-application copy \> runtime-mgr cloudhub-application copy \[options\] このコマンドは、​`source`​ で渡される CloudHub アプリケーションを ​`target`​ で渡される対象にコピーします。 引数 ​`source`​ および ​`target`​ は、​`([group_id]/)/`​ の形式にする必要があります。 `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​ コマンドのプロパティを渡します。 安全な隠しアプリケーションプロパティについては、​「アプリケーションプロパティを安全に隠す」​を参照してください。
# CloudHub アプリケーションの CLI
コマンド 説明

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

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

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

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

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

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

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

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

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

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

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

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

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

## [](#runtime-mgr-cloudhub-alert-list)runtime-mgr:cloudhub-alert:list \> runtime-mgr:cloudhub-alert:list \[flags\] このコマンドでは、現在の環境に関連付けられているすべてのアラートをリストします。 このコマンドには ​`--output`​ フラグを使用できます。​`--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 このコマンドでは、デフォルトのフラグ ​`--help`​ も受け入れます。 ## [](#runtime-mgr-cloudhub-alert-history-describe)runtime-mgr:cloudhub-alert-history:describe \> runtime-mgr:cloudhub-alert-history:describe \[flags\] このコマンドは、​``​ で渡されるアラームの履歴の情報を表示します。 このコマンドには ​`--output`​ フラグを使用できます。​`--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgr-cloudhub-application-list)runtime-mgr:cloudhub-application:list \> runtime-mgr:cloudhub-application:list \[flags\] このコマンドは、Anypoint Platform CLI で使用できるすべてのアプリケーションをリストします。アプリケーション、その状況、割り当てられている vCore の数、最終更新時間を返します。 このコマンドには ​`--output`​ フラグを使用できます。​`--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 このコマンドでは、デフォルトのフラグ ​`--help`​ も受け入れます。 ## [](#runtime-mgr-cloudhub-application-describe)runtime-mgr:cloudhub-application:describe \> runtime-mgr:cloudhub-application:describe \[flags\] このコマンドは、​``​ で渡すアプリケーションに関する情報を表示します。 フラグ ​`-o json`​ を使用して、​``​ で指定するアプリケーションの未加工の JSON 応答を取得します。 アプリケーションのドメイン、その状況、最終更新時間、Mule バージョン、ZIP ファイル名、リージョン、監視、ワーカー、および永続的なキューや静的 IP の有効化に関する ​`TRUE`​ または ​`FALSE`​ 情報などのデータを返します。 このコマンドには ​`--output`​ フラグを使用できます。​`--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 このコマンドでは、デフォルトのフラグ ​`--help`​ も受け入れます。 ## [](#runtime-mgr-cloudhub-application-stop)runtime-mgr:cloudhub-application:stop \> runtime-mgr:cloudhub-application:stop \[flags\] このコマンドは、​``​ で指定する実行中のアプリケーションを停止します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgr-cloudhub-application-start)runtime-mgr:cloudhub-application:start \> runtime-mgr:cloudhub-application:start \[flags\] このコマンドは、​``​ で指定する実行中のアプリケーションを開始します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgr-cloudhub-application-restart)runtime-mgr:cloudhub-application:restart \> runtime-mgr:cloudhub-application:restart \[flags\] このコマンドは、​``​ で指定する実行中のアプリケーションを再起動します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgr-cloudhub-application-delete)runtime-mgr:cloudhub-application:delete \> runtime-mgr:cloudhub-application:delete \[flags\] このコマンドは、​``​ で指定する実行中のアプリケーションを削除します。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#deploy-to-cloudhub)runtime-mgr:cloudhub-application:deploy \> runtime-mgr:cloudhub-application:deploy \[flags\] このコマンドは、​``​ で設定する名前を使用して、​``​ で指定する Mule のデプロイ可能なアーカイブ ZIP ファイルをデプロイします。 ローカルハードドライブのデプロイ可能な ZIP ファイルの絶対パスまたは相対パスを指定する必要があります。また、アプリケーションには一意の名前を付ける必要があります。
成功すると、このコマンドの出力に ​UNDEPLOYED​ のデプロイメントの状況が含まれます。これは、CloudHub でアプリケーションが正常にアップロードされたことを示します。
このコマンドで使用できるフラグは、次のとおりです。
フラグ 説明

--runtime

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

--workers

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

--workerSize

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

--region

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

--property

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

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

--propertiesFile

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

--[no-]persistentQueues

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

--[no-]persistentQueuesEncrypted

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

--[no-]staticIPsEnabled

静的 IP を有効または無効にする。このデフォルト値は ​disabled​。

--[no-]objectStoreV1

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

--[no-]objectStoreV2

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

--[no-]autoRestart

応答しない場合にアプリケーションを自動的に再起動する。このデフォルト値は ​enabled​。

--output

応答形式を指定する。サポートされている値は、​table​ (デフォルト) および ​json​ です。

--help

使用量情報を出力する

--timeout

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

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

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

Mule 4.5 以降、MuleSoft は Edge と長期サポート (LTS) という 2 つの新しいリリースチャネルを導入します。新しいリリースチャネルの Mule Runtime バージョン設定スキーマは次のとおりです。

メジャー[数値] .マイナー[数値] . パッチ[数値] : ビルド[数値] チャネル[Edge の場合は e、LTS の場合はなし]

これらの値の例としては、Edge の場合は ​4.5.0:1e​、LTS の場合は ​4.6.0:1​ となります。

詳細は、Edge and LTS Releases for Muleを参照してください。

このコマンドには複数オプションのフラグがあります。コマンドで複数オプションのフラグを使用する場合は、フラグの前にパラメーターを置くか、パラメーターの前に ​`-- `​ (2 つのダッシュの後にスペース) を使用します。
## [](#runtime-mgr-cloudhub-application-modify)runtime-mgr:cloudhub-application:modify \> runtime-mgr:cloudhub-application:modify \[zipfile\] \[flags\] このコマンドは、既存のアプリケーションの設定を更新します。必要に応じて、新しい ZIP ファイルをアップロードして更新できます。 このコマンドでは、​`deploy`​ コマンドとまったく同じフラグを使用できます。
このコマンドの出力には、​Status​ (アプリケーションの以前のデプロイメントの状況の状態) が含まれます。
このコマンドには複数オプションのフラグがあります。コマンドで複数オプションのフラグを使用する場合は、フラグの前にパラメーターを置くか、パラメーターの前に ​`-- `​ (2 つのダッシュの後にスペース) を使用します。
## [](#runtime-mgr-cloudhub-application-download-logs)runtime-mgr:cloudhub-application:download-logs \> runtime-mgr:cloudhub-application:download-logs \[flags\] このコマンドは、​``​ で指定されるアプリケーションのログを指定のディレクトリにダウンロードします。 UI とは異なり、CLI からダウンロードするログでは、システムログとワーカーログが分離されません。 ## [](#runtime-mgr-cloudhub-application-tail-logs)runtime-mgr:cloudhub-application:tail-logs \> runtime-mgr:cloudhub-application:tail-logs \[flags\] このコマンドは、アプリケーションログの末尾を表示します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgr-cloudhub-application-copy)runtime-mgr:cloudhub-application:copy \> runtime-mgr:cloudhub-application:copy \[flags\] このコマンドは、​`source`​ で渡される CloudHub アプリケーションを ​`target`​ で渡される対象にコピーします。 引数 ​`source`​ および ​`target`​ は、​`([group_id]/)/`​ の形式にする必要があります。 `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`​ フラグ以外に次のフラグも使用できます。
フラグ 説明

--property

プロパティ (​name:value​) を設定する。

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

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

このコマンドには複数オプションのフラグがあります。コマンドで複数オプションのフラグを使用する場合は、フラグの前にパラメーターを置くか、パラメーターの前に ​`-- `​ (2 つのダッシュの後にスペース) を使用します。
安全な隠しアプリケーションプロパティが含まれるアプリケーションをコピーする場合は、​--property​ フラグを使用して ​copy​ コマンドのプロパティを渡します。 安全な隠しアプリケーションプロパティについては、​「アプリケーションプロパティを安全に隠す」​を参照してください。
# CloudHub の CLI Anypoint CLI では次の CloudHub 機能の管理がサポートされます。 - [CloudHub アプリケーション](https://docs.mulesoft.com/jp/anypoint-cli/3.x/cloudhub-apps) - [CloudHub 専用ロードバランサー](https://docs.mulesoft.com/jp/anypoint-cli/3.x/cloudhub-dlb) - [Anypoint Virtual Private Cloud](https://docs.mulesoft.com/jp/anypoint-cli/3.x/cloudhub-vpc) # CloudHub の CLI Anypoint CLI では次の CloudHub 機能の管理がサポートされます。 - [CloudHub アプリケーション](https://docs.mulesoft.com/jp/anypoint-cli/latest/cloudhub-apps) - [CloudHub 専用ロードバランサー](https://docs.mulesoft.com/jp/anypoint-cli/latest/cloudhub-dlb) - [Anypoint Virtual Private Cloud](https://docs.mulesoft.com/jp/anypoint-cli/latest/cloudhub-vpc) # CloudHub 専用ロードバランサーの CLI

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。

コマンド 説明

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

動的 IP を有効にする

動的 IP を無効にする

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

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

## [](#cloudhub-load-balancer-list)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 \> cloudhub load-balancer describe \[options\] このコマンドは、`` で指定されるロードバランサーに関する情報を表示します。 ロードバランサーの名前の入力を開始して ​`tab`​ キーを押すと、Anypoint Platform CLI によって名前がオートコンプリートされます。また、​`tab`​ キーをダブルタップすると、渡すことができるすべての値の完全なリストが表示されます。 ロードバランサーの名前、ドメイン、その状態、およびロードバランサーがバインドされている Anypoint VPC ID を表示します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#cloudhub-load-balancer-describe-json)cloudhub load-balancer describe-json \> cloudhub load-balancer describe \[options\] このコマンドでは、`` で指定されるロードバランサーの未加工の JSON 応答を表示します。 ロードバランサーの名前の入力を開始して ​`tab`​ キーを押すと、Anypoint Platform CLI によって名前がオートコンプリートされます。また、​`tab`​ キーをダブルタップすると、渡すことができるすべての値の完全なリストが表示されます。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#cloudhub-load-balancer-create)cloudhub load-balancer create \> cloudhub load-balancer create \[options\] このコマンドは、環境変数で指定される値を使用してロードバランサーを作成します。
オプション 説明 例

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​ を使用してプログラムで証明書を更新することをお勧めします。
設定に関する詳細は、​[「SSL エンドポイントと証明書の設定」](https://docs.mulesoft.com/cloudhub/lb-ssl-endpoints)​を参照してください。 ## [](#cloudhub-load-balancer-start)cloudhub load-balancer start \> cloudhub load-balancer start \[options\] このコマンドは、​``​ で指定されるロードバランサーを開始します。 このコマンドでは、デフォルトのオプション (​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​) 以外のオプションは使用できません。 ## [](#cloudhub-load-balancer-stop)cloudhub load-balancer stop \> cloudhub load-balancer stop \[options\] このコマンドは、​``​ で指定されるロードバランサーを停止します。 このコマンドでは、デフォルトのオプション (​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​) 以外のオプションは使用できません。 ## [](#cloudhub-load-balancer-delete)cloudhub load-balancer delete \> cloudhub load-balancer delete \[options\] このコマンドは、​``​ で指定されるロードバランサーを削除します。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
このコマンドでは、デフォルトのオプション (​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​) 以外のオプションは使用できません。 ## [](#cloudhub-load-balancer-ssl-endpoint-add)cloudhub load-balancer ssl-endpoint add \> cloudhub load-balancer ssl-endpoint add \[options\] このコマンドは、渡される証明書と非公開キーを使用して、SSL エンドポイントを ​``​ で指定されるロードバランサーに追加します。
オプション 説明 例

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 エンドポイントと証明書の設定」](https://docs.mulesoft.com/cloudhub/lb-ssl-endpoints)​を参照してください。 ## [](#cloudhub-load-balancer-ssl-endpoint-remove)cloudhub load-balancer ssl-endpoint remove \> cloudhub load-balancer ssl-endpoint remove \[options\] このコマンドは、​``​ で指定されるロードバランサーから ​``​ で指定される SSL 証明書を削除します。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
このコマンドでは、デフォルトのオプション (​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​) 以外のオプションは使用できません。 ## [](#cloudhub-load-balancer-ssl-endpoint-set-default)cloudhub load-balancer ssl-endpoint set-default \> cloudhub load-balancer ssl-endpoint set-default \[options\] このコマンドは、`` で渡されるロードバランサーのデフォルトの証明書として `` で指定される証明書を設定します。 ロードバランサーの名前の入力を開始して ​`tab`​ キーを押すと、Anypoint Platform CLI によって名前がオートコンプリートされます。また、​`tab`​ キーをダブルタップすると、渡すことができるすべての値の完全なリストが表示されます。 このコマンドでは、デフォルトの ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ オプション以外に次のオプションも使用できます。
オプション 説明

http

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

## [](#cloudhub-load-balancer-ssl-endpoint-describe)cloudhub load-balancer ssl-endpoint describe \> cloudhub load-balancer ssl-endpoint describe \[options\] このコマンドは、​``​ で指定される証明書の ​``​ で渡されるロードバランサーの設定に関する情報を表示します。 ロードバランサーの名前の入力を開始して ​`tab`​ キーを押すと、Anypoint Platform CLI によって名前がオートコンプリートされます。また、​`tab`​ キーをダブルタップすると、渡すことができるすべての値の完全なリストが表示されます。 このコマンドでは、デフォルトのオプション (​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​) 以外のオプションは使用できません。 ## [](#cloudhub-load-balancer-whitelist-add)cloudhub load-balancer whitelist add \> cloudhub load-balancer whitelist add \[options\] このコマンドでは、​``​ で指定される IP アドレスの範囲を ​``​ で指定されるロードバランサーの許可リストに追加します。
許可リストは、CN 証明書レベルではなく、ロードバランサーレベルで動作します。 CIDR 表記​の形式の IP アドレスのみを渡してください。
ロードバランサーの名前の入力を開始して ​`tab`​ キーを押すと、Anypoint Platform CLI によって名前がオートコンプリートされます。また、​`tab`​ キーをダブルタップすると、渡すことができるすべての値の完全なリストが表示されます。 このコマンドでは、デフォルトのオプション (​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​) 以外のオプションは使用できません。 ## [](#cloudhub-load-balancer-whitelist-remove)cloudhub load-balancer whitelist remove \> cloudhub load-balancer whitelist remove このコマンドでは、​``​ で指定される IP または IP アドレスの範囲を ​``​ で指定されるロードバランサーの許可リストから削除します。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
このコマンドでは、デフォルトのオプション (​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​) 以外のオプションは使用できません。 ## [](#cloudhub-load-balancer-allowlist-add)cloudhub load-balancer allowlist add \> cloudhub load-balancer allowlist add \[options\] このコマンドでは、​``​ で指定される IP アドレスの範囲を ​``​ で指定されるロードバランサーの許可リストに追加します。
許可リストは、CN 証明書レベルではなく、ロードバランサーレベルで動作します。 CIDR 表記​の形式の IP アドレスのみを渡してください。
ロードバランサーの名前の入力を開始して ​`tab`​ キーを押すと、Anypoint Platform CLI によって名前がオートコンプリートされます。また、​`tab`​ キーをダブルタップすると、渡すことができるすべての値の完全なリストが表示されます。 このコマンドでは、デフォルトのオプション (​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​) 以外のオプションは使用できません。
包括的な製品表現プログラムに準拠して、「許可リスト」という用語を使用しています。
## [](#cloudhub-load-balancer-allowlist-remove)cloudhub load-balancer allowlist remove \> cloudhub load-balancer allowlist remove このコマンドでは、​``​ で指定される IP または IP アドレスの範囲を ​``​ で指定されるロードバランサーの許可リストから削除します。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
このコマンドでは、デフォルトのオプション (​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​) 以外のオプションは使用できません。
包括的な製品表現プログラムに準拠して、「許可リスト」という用語を使用しています。
## [](#cloudhub-load-balancer-mappings-describe)cloudhub load-balancer mappings describe \> cloudhub load-balancer mappings describe \[certificateName\] このコマンドは、​``​ で指定されるロードバランサーのマッピングルールをリストします。 `certificateName`​ が渡されない場合、Anypoint Platform CLI はデフォルトの SSL エンドポイントのマッピングを返します。 このコマンドでは、デフォルトのオプション (​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​) 以外のオプションは使用できません。 ## [](#cloudhub-load-balancer-mappings-add)cloudhub load-balancer mappings add \> cloudhub load-balancer mappings add \[options\] \[certificateName\] このコマンドは、​`certificateName`​ オプションで渡される CN の ​``​ で指定されるロードバランサーにプロキシマッピングルールを追加します。 `certificateName`​ が渡されない場合、Anypoint Platform CLI はマッピングをデフォルトの SSL エンドポイントに追加します。
オプション 説明 例

name

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

testloadbalancer

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 \> cloudhub load-balancer mappings remove \[options\] \[certificateName\] このコマンドは、​``​ で指定される優先度インデックスおよび ​`certificateName`​ オプションとして指定される CN で、​``​ で指定されるロードバランサーからプロキシマッピングルールを削除します。 このコマンドでは、デフォルトのオプション (​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​) 以外のオプションは使用できません。 ​`certificateName`​ が渡されない場合、Anypoint Platform CLI はデフォルトの SSL エンドポイントのマッピングを削除します。 ## [](#cloudhub-load-balancer-dynamic-ips-enable)cloudhub load-balancer dynamic-ips enable \> cloudhub load-balancer dynamic-ips enable \[options\] このコマンドは、​``​ で指定されるロードバランサーの動的 IP を有効にします。 このコマンドでは、デフォルトのオプション (​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​) 以外のオプションは使用できません。 ## [](#cloudhub-load-balancer-dynamic-ips-disable)cloudhub load-balancer dynamic-ips disable \> cloudhub load-balancer dynamic-ips disable \[options\] このコマンドは、​``​ で指定されるロードバランサーの動的 IP を無効にします。 このコマンドでは、デフォルトのオプション (​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​) 以外のオプションは使用できません。 ## [](#cloudhub-region-list)cloudhub region list \> cloudhub region list \[options\] このコマンドは、サポートされているすべてのリージョンをリストします。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#cloudhub-runtime-list)cloudhub runtime list \> cloudhub runtime list \[options\] このコマンドは、サポートされているすべてのランタイムをリストします。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 # CloudHub 専用ロードバランサーの CLI
コマンド 説明

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

動的 IP を有効にする

動的 IP を無効にする

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

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

## [](#cloudhub-load-balancer-list)cloudhub:load-balancer:list \> cloudhub:load-balancer:list \[flags\] このコマンドは、Anypoint Platform のすべてのロードバランサーをリストします。ロードバランサーの名前、ドメイン、その状態、およびロードバランサーがバインドされている Anypoint VPC ID を表示します。 このコマンドには ​`--output`​ フラグを使用できます。​`--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 このコマンドでは、デフォルトのフラグ ​`--help`​ も受け入れます。 ## [](#cloudhub-load-balancer-describe)cloudhub:load-balancer:describe \> cloudhub:load-balancer:describe \[flags\] このコマンドは、​``​ で指定されるロードバランサーに関する情報を表示します。 フラグ ​`-o json`​ を使用して、​``​ で指定するアプリケーションの未加工の JSON 応答を取得します。 ロードバランサーの名前、ドメイン、その状態、およびロードバランサーがバインドされている Anypoint VPC ID を表示します。 このコマンドには ​`--output`​ フラグを使用できます。​`--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 このコマンドでは、デフォルトのフラグ ​`--help`​ も受け入れます。 ## [](#cloudhub-load-balancer-create)cloudhub:load-balancer:create \> cloudhub:load-balancer:create \[flags\] このコマンドは、環境変数で指定される値を使用してロードバランサーを作成します。
値 説明 例

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`​ フラグ以外に次のフラグも受け入れます。
フラグ 説明

--http

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

--clientCertificate

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

--verificationMode

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

--crl

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

--[no-]tlsv1

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

--[no-]dynamic-ips

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

CloudHub は、オンライン証明書状況プロトコル (OCSP) を実装しません。証明書失効リストを最新の状態に保つには、 CloudHub API​ を使用してプログラムで証明書を更新することをお勧めします。
設定に関する詳細は、​[「SSL エンドポイントと証明書の設定」](https://docs.mulesoft.com/cloudhub/lb-ssl-endpoints)​を参照してください。 ## [](#cloudhub-load-balancer-start)cloudhub:load-balancer:start \> cloudhub:load-balancer:start \[flags\] このコマンドは、​``​ で指定されるロードバランサーを開始します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#cloudhub-load-balancer-stop)cloudhub:load-balancer:stop \> cloudhub:load-balancer:stop \[flags\] このコマンドは、​``​ で指定されるロードバランサーを停止します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#cloudhub-load-balancer-delete)cloudhub:load-balancer:delete \> cloudhub:load-balancer:delete \[flags\] このコマンドは、​``​ で指定されるロードバランサーを削除します。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#cloudhub-load-balancer-ssl-endpoint-add)cloudhub:load-balancer:ssl-endpoint:add \> cloudhub:load-balancer:ssl-endpoint:add \[flags\] このコマンドは、渡される証明書と非公開キーを使用して、SSL エンドポイントを ​``​ で指定されるロードバランサーに追加します。
値 説明 例

name

ロードバランサーの名前。

newtestloadbalancer

certificate

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

/Users/mule/Documents/cert.pem

privateKey

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

/Users/mule/Documents/privateKey.pem

CloudHub は、オンライン証明書状況プロトコル (OCSP) を実装しません。証明書失効リストを最新の状態に保つには、 CloudHub API​ を使用してプログラムで証明書を更新することをお勧めします。
このコマンドでは、デフォルトの ​`--help`​ フラグ以外に次のフラグも受け入れます。
フラグ 説明

--clientCertificate

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

--verificationMode

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

--crl

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

--tlsv1

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

設定に関する詳細は、​[「SSL エンドポイントと証明書の設定」](https://docs.mulesoft.com/cloudhub/lb-ssl-endpoints)​を参照してください。 ## [](#cloudhub-load-balancer-ssl-endpoint-remove)cloudhub:load-balancer:ssl-endpoint:remove \> cloudhub:load-balancer:ssl-endpoint:remove \[flags\] このコマンドは、​``​ で指定されるロードバランサーから ​``​ で指定される SSL 証明書を削除します。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#cloudhub-load-balancer-ssl-endpoint-set-default)cloudhub:load-balancer:ssl-endpoint:set-default \> cloudhub:load-balancer:ssl-endpoint:set-default \[flags\] このコマンドは、​``​ で渡されるロードバランサーのデフォルトの証明書として ​``​ で指定される証明書を設定します。 このコマンドでは、デフォルトの ​`--help`​ フラグ以外に次のフラグも受け入れます。
フラグ 説明

--http

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

## [](#cloudhub-load-balancer-ssl-endpoint-describe)cloudhub:load-balancer:ssl-endpoint:describe \> cloudhub:load-balancer:ssl-endpoint:set-describe \[flags\] このコマンドは、​``​ で指定される証明書の ​``​ で渡されるロードバランサーの設定に関する情報を表示します。 このコマンドには ​`--output`​ フラグを使用できます。​`--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 このコマンドでは、デフォルトのフラグ ​`--help`​ も受け入れます。 ## [](#cloudhub-load-balancer-allowlist-add)cloudhub:load-balancer:allowlist:add \> cloudhub:load-balancer:allowlist:add \[flags\] このコマンドでは、​``​ で指定される IP アドレスの範囲を ​``​ で指定されるロードバランサーの許可リストに追加します。
許可リストは、CN 証明書レベルではなく、ロードバランサーレベルで動作します。 CIDR 表記​の形式の IP アドレスのみを渡してください。
このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#cloudhub-load-balancer-allowlist-remove)cloudhub:load-balancer:allowlist:remove \> cloudhub:load-balancer:allowlist:remove このコマンドでは、​``​ で指定される IP または IP アドレスの範囲を ​``​ で指定されるロードバランサーの許可リストから削除します。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#cloudhub-load-balancer-mappings-describe)cloudhub:load-balancer:mappings:describe \> cloudhub:load-balancer:mappings:describe \[certificateName\] このコマンドは、​``​ で指定されるロードバランサーのマッピングルールをリストします。 `certificateName`​ が渡されない場合、Anypoint Platform CLI はデフォルトの SSL エンドポイントのマッピングを返します。 このコマンドには ​`--output`​ フラグを使用できます。​`--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 このコマンドでは、デフォルトのフラグ ​`--help`​ も受け入れます。 ## [](#cloudhub-load-balancer-mappings-add)cloudhub:load-balancer:mappings:add \> cloudhub:load-balancer:mappings:add \[flags\] \[certificateName\] このコマンドは、​`certificateName`​ フラグで渡される CN の ​``​ で指定されるロードバランサーにプロキシマッピングルールを追加します。 `certificateName`​ が渡されない場合、Anypoint Platform CLI はマッピングをデフォルトの SSL エンドポイントに追加します。
値 説明 例

name

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

testloadbalancer

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 \> cloudhub:load-balancer:mappings:remove \[flags\] \[certificateName\] このコマンドは、​``​ で指定される優先度インデックスおよび ​`certificateName`​ フラグとして指定される CN で、​``​ で指定されるロードバランサーからプロキシマッピングルールを削除します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 `certificateName`​ が渡されない場合、Anypoint Platform CLI はデフォルトの SSL エンドポイントのマッピングを削除します。 ## [](#cloudhub-load-balancer-dynamic-ips-enable)cloudhub:load-balancer:dynamic-ips:enable \> cloudhub:load-balancer:dynamic-ips:enable \[flags\] このコマンドは、​``​ で指定されるロードバランサーの動的 IP を有効にします。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#cloudhub-load-balancer-dynamic-ips-disable)cloudhub:load-balancer:dynamic-ips:disable \> cloudhub:load-balancer:dynamic-ips:disable \[flags\] このコマンドは、​``​ で指定されるロードバランサーの動的 IP を無効にします。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#cloudhub-region-list)cloudhub:region:list \> cloudhub:region:list \[flags\] このコマンドは、サポートされているすべてのリージョンをリストします。 このコマンドには ​`--output`​ フラグを使用できます。​`--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 このコマンドでは、デフォルトのフラグ ​`--help`​ も受け入れます。 ## [](#cloudhub-runtime-list)cloudhub:runtime:list \> cloudhub:runtime:list \[flags\] このコマンドは、サポートされているすべてのランタイムをリストします。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 # DataGraph API ソース管理の CLI
コマンド 説明

API ソースを追加する

API ソースを昇格する

API ソースを更新する

統合スキーマに対する API コールをスケーリングする

統合スキーマをダウンロードする

API ソースを削除する

API ソースを取得する

すべての API ソースをリストする

DataGraph に関する情報を返す

統合スキーマの API ソースを検証する

## [](#datagraph-sources-add)datagraph sources add \> datagraph sources add

DataGraph では、​stable​ 状態の API バージョンのみがサポートされています。

このコマンドは、​``​ で指定された API ソースを追加します。ここで、​`g`​ はグループ ID、​`a`​ はアセット ID、​`v`​ は API ソースのバージョン ID です。グループ ID は省略可能です。グループ ID を指定しない場合、このコマンドは現在の組織 ID を使用します。 このコマンドでは、デフォルトの ​`--help`​、​`-f/--fields`​、​`-o/--output`​、​`--verbose`​ オプション以外に次のオプションも使用できます。
オプション 説明

--auth-none

API が公開の場合に使用します。

--auth-basic

基本認証ヘッダー、またはユーザー名とパスワードを渡して、API に対する認証を行う場合に使用します。

必須:

  • --credentials <username>:<password>

--auth-oauth

OAuth 2.0 の ​client_id​、​client_secret​、認証サーバーの値を渡して API に対する認証を行う場合に使用します。

必須:

  • --credentials <client_id>:<client_secret>​

  • --server <authorization server URL>​ ​

    省略可能:

  • --scope <server>

--auth-pass-through

認証ヘッダーを渡して API に対する認証を行う場合に使用します。

必須:

  • ​--mapping: <comma-separated list of key-value pairs, for example, key1:value1,key2:value2>

--auth-headers

カスタムヘッダーパラメーターと値を渡して API に対する認証を行う場合に使用します。

ヘッダーで必須:

  • --custom-headers: <comma-separated list of header-value pairs, for example, header1:value1,header2:value2>​

    Or (または)

  • --custom-headers-file: <location of the file containing header-value pairs, one per line>

--auth-query-params

クエリパラメーターと値を渡して API に対する認証を行う場合に使用します。

クエリパラメーターで必須:

  • --credentials <client_id:client_secret>

--url <url>

バックエンド API の URL を設定します。

--discover-url

現在の環境で実行されているインスタンスに基づいて、バックエンド API の URL を自動的に検出します。複数の API が実行されている場合、DataGraph は最初の URL を使用します。

--ca

API のトラストストアに追加する認証機関 (CA) ファイルのカンマ区切りリストを指定します (​file.ca,file2.ca​ など)。

--cert

相互トランスポートレイヤーセキュリティ (mTLS) に使用するクライアント証明書のファイル名を指定します (​cert.ca​ など)。

--key

mTLS に使用する非公開キーのファイル名を指定します (​key.pem​ など)。

--key-password

暗号化された非公開キーを復号化するパスワードを指定します。

--ignore-invalid-edits

API 仕様の拡張機能で行われた有効な編集を適用し、無効な編集を無視するために使用します。

コマンドラインで定義されたすべてのヘッダーとクエリパラメーター、およびすべてのヘッダーとクエリパラメーターファイルが追加されます。反復キーがある場合、コマンドラインで指定された値が優先されます。
### [](#コマンド例)コマンド例 ```copy datagraph sources add 18dc11ee-4a09-4aae-9c6c-4371a87eafa8/product-api/1.0.0/ --url http://test.com ``` ### [](#出力例)出力例 { "apiVersion": "v1", "assetId": "product-api", "createDate": "2022-05-20T18:05:41", "endpoint": "http://test.com", "environmentId": "", "groupId": "", "name": "Product API", "organizationId": "", "securityScheme": "NO\_AUTH", "sourceId": "deca7be1-c299-4441-bc7b-dba733e3a11f", "updateDate": "2022-05-20T18:05:41", "version": "1.0.0", "origin": "CLI" } ## [](#datagraph-sources-promote)datagraph sources promote \> datagraph sources promote このコマンドは、API ソース ​``​ を対象環境 ​``​ に昇格します。 このコマンドでは、デフォルトの ​`--help`​、​`-f/--fields`​、​`-o/--output`​、​`--verbose`​ オプション以外に次のオプションも使用できます。
オプション 説明

--auth-none

API が公開の場合に使用します。

--auth-basic

基本認証ヘッダー、またはユーザー名とパスワードを使用して、API に対する認証を行う場合に使用します。

必須:

  • --credentials <username>:<password>

--auth-oauth

OAuth 2.0 の ​client_id​、​client_secret​、認証サーバーの値を渡して API に対する認証を行う場合に使用します。

必須:

  • --client-credentials <client_id>:<client_secret>​

  • --server <authorization server URL>​ ​

    省略可能:

  • --scope <server>

--auth-pass-through

認証ヘッダーを渡して API に対する認証を行う場合に使用します。

必須:

  • ​--mapping: <comma-separated list of key-value pairs, for example, key1:value1,key2:value2>

--auth-headers

カスタムヘッダーパラメーターと値を渡して API に対する認証を行う場合に使用します。

ヘッダーで必須:

  • --custom-headers: <comma-separated list of header-value pairs, for example, header1:value1,header2:value2>​

    Or (または)

  • --custom-headers-file: <location of the file containing header header-value pairs, one per line>

--auth-query-params

クエリパラメーターと値を渡して API に対する認証を行う場合に使用します。

クエリパラメーターで必須:

  • --credentials <client_id:client_secret>

--url

バックエンド API の URL を設定します。

--discover-url

現在の環境で実行されているインスタンスに基づいて、バックエンド API の URL を自動的に検出します。複数の API が実行されている場合、DataGraph は最初の URL を使用します。

--ca

API のトラストストアに追加する CA ファイルのリストを指定します。

--cert

mTLS に使用するクライアント証明書を指定します。

--key

mTLS に使用する非公開キーを指定します。

--key-password

暗号化された非公開キーを復号化するパスワードを指定します。

--empty-ca

すべての CA 証明書を削除します。

--empty-mtls

クライアント証明書、非公開キー、非公開キーパスワード情報を削除します。

コマンドラインで定義されたすべてのヘッダーとクエリパラメーター、およびすべてのヘッダーとクエリパラメーターファイルが追加されます。反復キーがある場合、コマンドラインで指定された値が優先されます。
### [](#コマンド例-2)コマンド例 この例では、​`promote`​ コマンドの実行後に ​`environmentId`​ が変更されます。 ```copy datagraph sources promote d1d27987-939a-4b41-b3ef-411568ee5bdd e7e8da65-9cf1-569e-c9d2-brd2r0rc7rd6 --auth-none ``` ### [](#出力例-2)出力例 { "apiVersion": "1.0", "assetId": "order-e2e", "createDate": "2022-05-27T18:56:03", "endpoint": "http://test.com", "environmentId": "e7e8da65-9cf1-569e-c9d2-brd2r0rc7rd6", "groupId": "", "name": "Order E2E", "organizationId": "", "securityScheme": "NO\_AUTH", "sourceId": "1ff021b3-9296-43fd-9d64-2f9027c25740", "updateDate": "2022-05-27T18:56:03", "version": "1.0.0", "origin": "CLI" } ## [](#datagraph-sources-update)datagraph sources update \> datagraph sources update

DataGraph では、​stable​ 状態の API バージョンのみがサポートされています。​update​ コマンドは、API ソースのパッチおよびマイナーバージョンのみを更新します。

このコマンドは、API ソース ​``​ のバージョンを更新します。 このコマンドでは、デフォルトの ​`--help`​、​`-f/--fields`​、​`-o/--output`​、​`--verbose`​ オプション以外に次のオプションも使用できます。
オプション 説明

--auth-none

API が公開の場合に使用します。

--auth-basic

基本認証ヘッダー、またはユーザー名とパスワードの両方を渡して、API に対する認証を行う場合に使用します。

必須:

  • --credentials <username>:<password>

--auth-oauth

OAuth 2.0 の ​client_id​、​client_secret​、認証サーバーの値を渡して API に対する認証を行う場合に使用します。

必須:

  • --credentials <client_id>:<client_secret>​

  • --server <authorization server URL>​ ​

    省略可能:

  • --scope <server>

--auth-pass-through

認証ヘッダーを渡して API に対する認証を行う場合に使用します。

必須:

  • ​--mapping: <comma-separated list of key-value pairs, for example, key1:value1,key2:value2>

--auth-headers

カスタムヘッダーパラメーターと値を渡して API に対する認証を行う場合に使用します。

ヘッダーで必須:

  • --custom-headers: <comma-separated list of header-value pairs, for example, header1:value1,header2:value2>​

    Or (または)

  • --custom-headers-file: <location of the file containing header-value pairs, one per line>

--auth-query-params

クエリパラメーターと値を渡して API に対する認証を行う場合に使用します。

クエリパラメーターで必須:

  • --credentials <client_id:client_secret>

--url

バックエンド API の URL を設定します。

--discover-url

現在の環境で実行されているインスタンスに基づいて、バックエンド API の URL を自動的に検出します。複数の API が実行されている場合、DataGraph は最初の URL を使用します。

--ca

API のトラストストアに追加する CA ファイルのリストを指定します。

--cert

mTLS に使用するクライアント証明書を指定します。

--key

mTLS に使用する非公開キーを指定します。

--key-password

暗号化された非公開キーを復号化するパスワードを指定します。

--empty-ca

すべての CA 証明書を削除します。

--empty-mtls

クライアント証明書、非公開キー、非公開キーパスワード情報を削除します。

--keep-edits

API ソースの現在のバージョンに存在する編集を、API 仕様から抽出する代わりに保持します。

--override-ui-edits

API ソースの取得元を CLI に変更します。API ソースの取得元が DataGraph UI である場合、このオプションを使用して、UI の編集を API 仕様の編集で上書きします。

--ignore-invalid-edits

API 仕様の拡張機能で行われた有効な編集を適用し、無効な編集を無視するために使用します。

コマンドラインで定義されたすべてのヘッダーとクエリパラメーター、およびすべてのヘッダーとクエリパラメーターファイルが追加されます。反復キーがある場合、コマンドラインで指定された値が優先されます。
### [](#コマンド例-3)コマンド例 次のコマンドは、ソース API の URL を更新し、その認証を ​`auth-none`​ から ​`auth-basic`​ に変更して、クライアント ID とシークレットを追加します。 ```copy > datagraph sources update b6cb82a6-51dc-4968-861a-aa04447c3442 --url http://test2.com --version 1.0.0 --auth-basic --credentials client-test:client-secret ``` ### [](#出力例-3)出力例 { "apiVersion": "v1", "assetId": "product-api", "createDate": "2022-05-20T18:56:57Z", "endpoint": "http://test2.com", "environmentId": "", "groupId": "", "name": "Product API", "organizationId": "", "securityScheme": "BASIC", "sourceId": "b6cb82a6-51dc-4968-861a-aa04447c3442", "updateDate": "2022-05-27T18:31:39", "version": "1.0.0", "origin": "CLI" } ## [](#datagraph-scale)datagraph scale \> datagraph scale このコマンドでは、統合スキーマで許可される同時 API コール数を設定できます。API コール数を増減することで、必要に応じて処理するワークロードを増やし、コンシュームを最適化できます。 このコマンドはデフォルトのオプション ​`--help`​、​`-f/--fields`​、​`-o/--output`​、​`--verbose`​ を受け入れます。 ### [](#コマンド例-4)コマンド例 ```copy datagraph scale 300 ``` ### [](#出力例-4)出力例 { "message": "Api calls updated" } ## [](#datagraph-schema-download)datagraph schema-download \> datagraph schema-download このコマンドは、現在の環境の統合スキーマをダウンロードします。 このコマンドはデフォルトのオプション ​`--help`​、​`-f/--fields`​、​`-o/--output`​、​`--verbose`​ を受け入れます。 ### [](#出力例-5)出力例 directive @key(fields: String) on OBJECT "An Item" type Item { itemId: Int! "A Product" product: OrderProduct! quantity: Int! } "An Order" type Order { items: \[Item!\]! orderId: String! customerId: String! } "A Product" type OrderProduct { productId: String! name: String! } type Query { orders(ordersCount: Int): \[Order!\] ordersByOrderId(orderId: String!): Order ordersProductsByOrderId(productsCounts: Int, orderId: String!): \[OrderProduct!\] } ## [](#datagraph-sources-delete)datagraph sources delete \> datagraph sources delete このコマンドは、指定された API ソースを削除します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f/--fields`​、​`-o/--output`​、​`--verbose`​ を受け入れます。 ### [](#コマンド例-5)コマンド例 ```copy datagraph sources delete d40df394-785d-4c91-8aeb-f07568dd57c ``` ### [](#出力例-6)出力例 { "message": "Source deleted successfully", "sourceId": "620afe93-b196-42eb-ae77-b68a0a937b6a" } ## [](#datagraph-sources-get)datagraph sources get \> datagraph sources get このコマンドは、指定された API ソースを取得します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f/--fields`​、​`-o/--output`​、​`--verbose`​ を受け入れます。 ### [](#コマンド例-6)コマンド例 ```copy datagraph sources get d1d27987-939a-4b41-b3ef-411568ee5bdd ``` ### [](#出力例-7)出力例 { "apiVersion": "1.0", "assetId": "order-e2e", "createDate": "2022-05-20T16:49:00Z", "hasKeystore": false, "endpoint": "http://test.com", "environmentId": "", "groupId": "", "name": "Order E2E", "organizationId": "", "hasTruststore": false, "securityScheme": "NO\_AUTH", "sourceId": "d1d27987-939a-4b41-b3ef-411568ee5bdd", "updateDate": "2022-05-20T16:49:00Z", "version": "1.0.0", "origin": "CLI" } ## [](#datagraph-sources-list)datagraph sources list ```copy > datagraph sources list ``` このコマンドは、現在の環境のすべての API ソースをリストします。 このコマンドはデフォルトのオプション ​`--help`​、​`-f/--fields`​、​`-o/--output`​、​`--verbose`​ を受け入れます。 ### [](#出力例-8)出力例 { "apiVersion": "1.0", "assetId": "order-e2e", "createDate": "2022-05-20T16:49:00.000Z", "endpoint": "http://test.com", "environmentId": "", "groupId": "", "name": "Order E2E", "organizationId": "", "securityScheme": "NO\_AUTH", "sourceId": "d1d27987-939a-4b41-b3ef-411568ee5bdd", "updateDate": "2022-05-20T16:49:00.000Z", "version": "1.0.0", "origin": "CLI" }, { "apiVersion": "v1", "assetId": "product-api", "createDate": "2022-05-20T18:05:41.000Z", "endpoint": "http://test.com", "environmentId": "", "groupId": "", "name": "Product API", "organizationId": "", "securityScheme": "NO\_AUTH", "sourceId": "deca7be1-c299-4441-bc7b-dba733e3a11f", "updateDate": "2022-05-20T18:05:41.000Z", "version": "1.0.0", "origin": "CLI" } ## [](#datagraph-describe)datagraph describe ```copy > datagraph describe ``` このコマンドは、DataGraph に関する次の情報を返します。 - `endpoint`​: 要求を受け入れる GraphQL エンドポイントを表示します。 - `deploymentError`​: DataGraph のデプロイメントが失敗した場合、この項目にエラーの情報が表示されます。それ以外の場合は空です。 - `deploymentStatus`​: DataGraph はデプロイ中、実行中、またはエラーがあるかどうかを示します。 - `logLevels`​: 設定されたログレベルのリストを表示します。 - `envStatus`​: 現在の環境の状況を表示します。 - `dlbEndpoint`​: ロードバランサーエンドポイントを表示します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f/--fields`​、​`-o/--output`​、​`--verbose`​ を受け入れます。 ### [](#出力例-9)出力例 { "deploymentStatus": "STARTED", "dlbEndpoint": "datagraph-example.us-e1.prod.cloudhub.io", "endpoint": "datagraph-example.us-e1.prod.cloudhub.io", "envStatus": "STARTED" } ## [](#datagraph-validate)datagraph validate \> datagraph validate asset このコマンドは、API ソースを統合スキーマに追加できるかどうかを検証します。そのために、このコマンドは次の処理を行います。 - API ソースを GraphQL スキーマに変換する。 - API 仕様に適用されている API 拡張機能を検証する。 - 統合スキーマに対して競合チェックを実行する。 これらのステップのいずれかで競合またはエラーが発生した場合、コマンドは結果を返します。競合やエラーが見つからない場合は、成功メッセージを返します。 検証する API ソースは、​``​ で指定されます。ここで、​`g`​ はグループ ID、​`a`​ はアセット ID、​`v`​ は API ソースのバージョン ID です。グループ ID は省略可能です。グループ ID を指定しない場合、このコマンドは現在の組織 ID を使用します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f/--fields`​、​`-o/--output`​、​`--verbose`​ を受け入れます。 ### [](#コマンド例-7)コマンド例 ```copy datagraph validate asset 73b0d8f2-5a2f-4107-884d-fcd80f30bc51/sales-api/1.0.0 ``` ### [](#出力例-10)出力例 { "code": "success" } # DataGraph ロードバランサーの CLI
コマンド 説明

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

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

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

## [](#datagraph-load-balancer-config-add)datagraph load-balancer-config add ```copy > datagraph load-balancer-config add ``` このコマンドでは、​``​ で指定された専用ロードバランサー設定を Anypoint DataGraph に追加します。 `dlbUrl`​ は、DLB ドメインとマッピングルール ​`inputUri`​ を含む有効な URL です。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#datagraph-load-balancer-config-describe)datagraph load-balancer-config describe ```copy > datagraph load-balancer-config describe [options] ``` このコマンドでは、Anypoint DataGraph の専用ロードバランサーの URL を表示します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#datagraph-load-balancer-config-remove)datagraph load-balancer-config remove ```copy > datagraph load-balancer-config remove [options] ``` このコマンドでは、専用ロードバランサー設定を Anypoint DataGraph から削除します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 # DataGraph ロードバランサーの CLI
コマンド 説明

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

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

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

## [](#datagraph-load-balancer-config-add)datagraph:load-balancer-config:add ```copy > datagraph:load-balancer-config:add ``` このコマンドでは、​``​ で指定された専用ロードバランサー設定を Anypoint DataGraph に追加します。 `dlbUrl`​ は、DLB ドメインとマッピングルール ​`inputUri`​ を含む有効な URL です。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#datagraph-load-balancer-config-describe)datagraph:load-balancer-config:describe ```copy > datagraph:load-balancer-config:describe [flags] ``` このコマンドでは、Anypoint DataGraph の専用ロードバランサーの URL を表示します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#datagraph-load-balancer-config-remove)datagraph:load-balancer-config:remove ```copy > datagraph:load-balancer-config:remove [flags] ``` このコマンドでは、専用ロードバランサー設定を Anypoint DataGraph から削除します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 # Design Center プロジェクトの CLI
コマンド 説明

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

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

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

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

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

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

## [](#designcenter-project-create)designcenter project create \> designcenter project create \[options\] このコマンドは、​``​ で指定される名前を使用して、新しい Design Center プロジェクトを作成します。
このコマンドでは、Mule アプリケーション種別はサポートされていません。
このコマンドでは、デフォルトの ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ オプション以外に次のオプションも使用できます。
オプション 説明 例

--type (必須)

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

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

  • raml​

  • raml-fragment

designcenter project create --type raml

--fragment-type

フラグメントタイプ。OAS 3.0 および JSON スキーマフラグメントの場合でも、常に ​--type raml-fragment​ と共に使用します。

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

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

  • trait​

  • resource-type​

  • library​

  • type​

  • user-documentation​

  • oas-components​

  • json-schema

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

## [](#designcenter-project-delete)designcenter project delete \> designcenter project delete \[options\] このコマンドは、​`name`​ で指定される Design Center プロジェクトを削除します。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#designcenter-project-download)designcenter project download \> designcenter project download \[options\] このコマンドでは、​`name`​ で渡される Design Center プロジェクトを ​`targetDir`​ で指定されるローカルディレクトリにダウンロードします。 `--branch`​ オプションを使用して、コンテンツをダウンロードするブランチを選択します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ も受け入れます。 ## [](#designcenter-project-publish)designcenter project publish \> designcenter project publish \[options\] このコマンドは、​`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

--branch

アセットのブランチ。

designcenter project publish --branch main

## [](#designcenter-project-upload)designcenter project upload \> designcenter project upload \[options\] このコマンドは、​`projDir`​ で渡されるローカルディレクトリの Design Center プロジェクトのコンテンツを ​`name`​ で識別された既存の Design Center プロジェクトにアップロードします。 デフォルトでは、このコマンドは非表示のファイルおよびディレクトリをすべて無視します。非表示のファイルおよびディレクトリを含めるには、​`--include-dot-files`​ オプションを使用します。 `--include-dot-files`​ オプションを使用すると、コマンドは指定されたディレクトリの非表示のファイルおよびフォルダーをアップロードします。 `--branch`​ オプションを使用して、コンテンツをアップロードするブランチを選択します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ も受け入れます。 ## [](#designcenter-project-list)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

# Design Center プロジェクトの CLI
コマンド 説明

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

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

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

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

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

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

## [](#designcenter-project-create)designcenter:project:create \> designcenter:project:create \[flags\] このコマンドは、​``​ で指定される名前を使用して、新しい Design Center プロジェクトを作成します。
このコマンドでは、Mule アプリケーション種別はサポートされていません。
このコマンドでは、デフォルトの ​`--help`​ フラグ以外に次のフラグも受け入れます。
フラグ 説明 例

--type (必須)

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

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

  • raml​

  • raml-fragment

--type raml

--fragmentType

フラグメントタイプ。OAS 3.0 および JSON スキーマフラグメントの場合でも、常に ​--type raml-fragment​ と共に使用します。

type フラグが ​raml-fragment​ として設定されている場合、この項目は必須です。

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

  • trait​

  • resource-type​

  • library​

  • type​

  • user-documentation​

  • oas-components​

  • json-schema

--type raml-fragment --fragmentType user-documentation

--output

応答形式を指定する。

--output json​

## [](#designcenter-project-delete)designcenter:project:delete \> designcenter:project:delete \[flags\] このコマンドは、​`name`​ で指定される Design Center プロジェクトを削除します。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#designcenter-project-download)designcenter:project:download \> designcenter:project:download \[flags\] このコマンドでは、​`name`​ で渡される Design Center プロジェクトを ​`targetDir`​ で指定されるローカルディレクトリにダウンロードします。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#designcenter-project-publish)designcenter:project:publish \> designcenter:project:publish \[flags\] このコマンドは、​`projectName`​ で渡される Design Center プロジェクトを Exchange をパブリッシュします。 このコマンドでは、デフォルトの ​`--help`​ フラグ以外に次のフラグも受け入れます。
指定されていないフラグは、exchange.json から抽出されます。
フラグ 説明 例

--name

アセットの名前

--name sampleProject

--main

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

--main sample.xml

--apiVersion

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

--main sample.raml --apiVersion 1.0

--tags

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

--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 \> designcenter:project:upload \[flags\] このコマンドは、​`projDir`​ で渡されるローカルディレクトリの Design Center プロジェクトのコンテンツを ​`name`​ で識別された既存の Design Center プロジェクトにアップロードします。 デフォルトでは、このコマンドは非表示のファイルおよびディレクトリをすべて無視します。非表示のファイルおよびディレクトリを含めるには、​`--include-dot-files`​ フラグを使用します。 `--include-dot-files`​ フラグを使用すると、コマンドは指定されたディレクトリの非表示のファイルおよびフォルダーをアップロードします。 このコマンドでは、​`--include-dot-files`​ フラグ以外にデフォルトの ​`--help`​ フラグも使用できます。 ## [](#designcenter-project-list)designcenter:project:list \> designcenter:project:list \[flags\] \[searchText\] このコマンドは、すべての Design Center プロジェクトをリストします。 このコマンドでは、デフォルトの ​`--help`​ フラグ以外に次のフラグも受け入れます。
フラグ 説明 例

--pageIndex

取得するページの数

--pageIndex 3

--pageSize

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

--pageSize 5

--output

応答形式を指定する。

--output json​

# Exchange アセットの CLI
コマンド 説明

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

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

既存の Exchange アセットの変更可能なデータを変更する

既存の Exchange アセットの状況を変更する

Exchange アセットを変更する

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

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

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

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

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

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

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

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

Exchange アセットをコピーする

Exchange のアセットを削除する

アセットを非推奨にする

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

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

アセットポータルにリソースをアップロードする

アセットポータルでパブリッシュ済みのリソースをリストする

アセットポータルからリソースをダウンロードする

アセットポータルからリソースを削除する

## [](#exchange-asset-upload)exchange asset upload \> exchange asset upload \[options\] \[filePath\] このコマンドは、​``​ で渡される ID を使用して、OAS、RAML、WSDL、HTTP、またはカスタムアセットをアップロードします。 ``​ で ZIP アーカイブファイルが参照されている場合、アセットを記述する ​`exchange.json`​ ファイルがそのアーカイブに含まれている必要があります。 引数 ​`assetIdentifier`​ は、​`//`​ の形式にする必要があります。 このコマンドでは、デフォルトの ​`--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 \> exchange asset uploadv2 \[properties\] このコマンドでは、 で渡される 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​

  • ruleset​

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

アセットタイプに応じて、次のような分類子の値があります。

  • REST API

    • oas​ (​zip​、​yaml​、または ​json​ をパッケージとして使用)

    • raml​ (​zip​ または ​raml​ をパッケージとして使用)

  • RAML フラグメント

    • raml-fragment​ (​zip​ または ​raml​ をパッケージとして使用)

  • SOAP API

    • wsdl​ (​zip​、​wsld​、または ​xml​ をパッケージとして使用)

  • Custom (カスタム)

    • custom​

  • アプリケーション

    • mule-application​ (​jar​ をパッケージとして使用)

  • ポリシー

    • mule-policy​ (​jar​ をパッケージとして使用) + ​policy-definition​ (​yaml​ をパッケージとして使用)

  • 例

    • mule-application-example​ (​jar​ をパッケージとして使用)

  • Template (テンプレート)

    • mule-application-template​ (​jar​ をパッケージとして使用)

  • Extension (拡張子)

    • mule-plugin​ (​jar​ をパッケージとして使用)

  • Connector (コネクタ)

    • studio-plugin​ (​zip​ をパッケージとして使用) + 分類子がなくパッケージ ​jar​ を使用するファイル

  • 外部ライブラリ

    • external-library​ (​jar​ をパッケージとして使用)

--categories

カテゴリ

categories.someKey value​

categories.anotherKey anotherValue​

--fields

項目

fields.someKey value​

fields.anotherKey anotherValue​

--keywords

キーワード (カンマ区切り)

raml,rest-api,someKeyword​

--tags

タグ (カンマ区切り)

api,tag1,tag2​

--dependencies

アセットの連動関係 (カンマ区切り)

groupID:assetID:version,groupID2:assetID:version​

--status

アセットの状況

サポートされる値:

  • development​

  • published​

デフォルト値:

  • published

development

## [](#exchange-asset-mutabledataupload)exchange asset mutableDataUpload \> exchange asset mutableDataUpload \[properties\] このコマンドでは、タグ、カテゴリ、項目、ドキュメントを含む作成済みの変更可能なデータを変更します。 _assetIdentifier_​ 引数には次の形式を使用します。 `[​__​]/​__​/__` _group\_id_ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。
オプション 説明 例

--docs

ドキュメントファイル。(「zip」ファイルパスを指定する必要があります。例: "--docs /…​/file-path/docs.zip")

exchange asset mutableDataUpload --docs /Users/llucas/Desktop/examples/docs.zip --tags "tag1,tag2" --categories.beach sun --fields.central park fa7b266c-3817-4cbb-ae49-7f3cc6c8cd9e/asset-id/1.0.0​

--categories

カテゴリ

categories.someKey value​

categories.anotherKey anotherValue​

--fields

項目

fields.someKey value​

fields.anotherKey anotherValue​

--tags

タグ (カンマ区切り)

api,tag1,tag2​

## [](#exchange-asset-updatestatus)exchange asset updateStatus \> exchange asset updateStatus \[properties\] このコマンドは、作成済みのアセットの状況を変更します。 _assetIdentifier_​ 引数には次の形式を使用します。 `[​__​]/​__​/__` _group\_id_ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。
コマンド 説明 例

--status

アセットの状況

サポートされる値:

  • published​

  • deprecated

exchange asset updateStatus --status deprecated​

有効な移行:
移行元 移行先

development

published

published

deprecated

deprecated

published

`published`​ 状態は ​`stable`​ 状態に対応することに注意してください ## [](#exchange-asset-modify)exchange asset modify \> exchange asset modify \[options\] このコマンドは、​``​ で識別される Exchange アセットを変更します。 引数 ​`assetIdentifier`​ は、​`([group_id]/)/`​ の形式にする必要があります。 `group_id`​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。 このコマンドでは、デフォルトの ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ オプション以外に次のオプションも使用できます。
オプション 説明 例

--name

新しいアセット名

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

--tags

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

## [](#exchange-asset-download)exchange asset download \> exchange asset download \[options\] このコマンドは、​``​ で識別される Exchange アセットを ​``​ で渡されるディレクトリにダウンロードします。 引数 ​`assetIdentifier`​ は、​`([group_id]/)/`​ の形式にする必要があります。 `group_id`​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#exchange-asset-list)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

--organizationId

組織 ID で絞り込む

exchange asset list --organizationId a12b3c45-de6f-789g-hi01-j2klm3nop4q5

## [](#exchange-asset-page-download)exchange asset page download \> exchange asset page download \[options\] \[pageName\] このコマンドは、​``​ で識別される Exchange アセットの ​``​ で指定される説明ページを ​``​ で渡されるディレクトリにダウンロードします。 \[pageName\] が指定されていない場合、このコマンドはすべてのページをダウンロードします。
このコマンドでは、パブリッシュ済みページのみがサポートされています。
引数 ​`assetIdentifier`​ は、​`([group_id]/)/`​ の形式にする必要があります。 `group_id`​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。 説明ページは、マークダウン形式でダウンロードされます。​`name`​ が指定されていない場合、すべてのページがダウンロードされます。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#exchange-asset-page-modify)exchange asset page modify \> exchange asset page modify \[options\] このコマンドは、​``​ で識別される Exchange アセットの ​``​ で指定される説明ページを変更します。
このコマンドでは、パブリッシュ済みページのみがサポートされています。
引数 ​`assetIdentifier`​ は、​`([group_id]/)/`​ の形式にする必要があります。 `group_id`​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。 このコマンドでは、デフォルトの ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ オプション以外に、新しいアセットページ名を設定する ​`--name`​ オプションも使用できます。 ## [](#exchange-asset-page-upload)exchange asset page upload \> exchange asset page upload \[options\] このコマンドは、​``​ で指定される名前を使用して、アセットの説明ページを ​``​ で渡されるパスから ​``​ で識別される Exchange アセットにアップロードします。 ページの名前を「home」にすると、アップロードされたページが Exchange アセットのメイン説明ページになります。
このコマンドでは、操作の一環としてすべてのアクティブなドラフトをパブリッシュします。
引数 ​`assetIdentifier`​ は、​`[group_id]//`​ の形式にする必要があります。 `group_id`​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#exchange-asset-page-update)exchange asset page update \> exchange asset page update \[options\] このコマンドでは、​``​ で指定される名前を使用して、アセットの説明ページのコンテンツを ​``​ で渡されるパスから ​``​ で識別される Exchange アセットに更新します。 ページの名前を「home」にすると、更新されたページが Exchange アセットのメイン説明ページになります。
このコマンドでは、操作の一環としてすべてのアクティブなドラフトをパブリッシュします。
引数 ​`assetIdentifier`​ は、​`[group_id]//`​ の形式にする必要があります。 `group_id`​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#exchange-asset-page-delete)exchange asset page delete \> exchange asset page delete \[options\] このコマンドは、​``​ で識別されるアセットの ​``​ で指定される説明ページを削除します。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
このコマンドでは、パブリッシュ済みページのみがサポートされています。
引数 ​`assetIdentifier`​ は、​`([group_id]/)/`​ の形式にする必要があります。 `group_id`​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#exchange-asset-page-list)exchange asset page list \> exchange asset page list このコマンドは、​``​ で渡されるアセットのすべてのページをリストします。 引数 ​`assetIdentifier`​ は、​`([group_id]/)/`​ の形式にする必要があります。 `group_id`​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。
このコマンドでは、パブリッシュ済みページのみがサポートされています。
このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#exchange-asset-copy)exchange asset copy \> exchange asset copy \[options\] このコマンドは、​``​ から ​``​ に Exchange アセットをコピーします。 引数 ​``​ および ​``​ は、​`([group_id]/)/`​ の形式にする必要があります。 `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 \> exchange asset delete \[options\] このコマンドは、​``​ で渡される Exchange アセットを削除します。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
引数 ​`assetIdentifier`​ は、​`([group_id]/)/`​ の形式にする必要があります。 `group_id`​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#exchange-asset-deprecate)exchange asset deprecate \> exchange asset deprecate このコマンドは、​``​ で渡されるアセットを非推奨にします。 引数 ​`assetIdentifier`​ は、​`([group_id]/)/`​ の形式にする必要があります。 `group_id`​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#exchange-asset-undeprecate)exchange asset undeprecate \> exchange asset undeprecate このコマンドは、​``​ で渡されるアセットの非推奨を解除します。 引数 ​`assetIdentifier`​ は、​`([group_id]/)/`​ の形式にする必要があります。 `group_id`​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#exchange-asset-describe)exchange asset describe \> exchange asset describe このコマンドは、​``​ で渡されるアセットの情報を表示します。 引数 ​`assetIdentifier`​ は、​`([group_id]/)/`​ の形式にする必要があります。 `group_id`​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#exchange-asset-resource-upload)exchange asset resource upload \> exchange asset resource upload \[options\] このコマンドでは、​``​ で指定されたリソースを ​``​ で説明されるアセットポータルのページにアップロードします。 このコマンドは、​``​ アセットの任意のページに使用できます。 ``​ でサポートされるファイルの拡張子は、​`jpeg`​、​`jpg`​、​`jpe`​、​`gif`​、​`bmp`​、​`png`​、​`webp`​、​`ico`​、​`svg`​、​`tiff`​、​`tif`​。 引数 ​`assetIdentifier`​ は、​`[group_id]//`​ の形式にする必要があります。 `group_id`​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。 成功した出力コマンドはマークダウンコードスニペットになります。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#exchange-asset-resource-list)exchange asset resource list \> exchange asset resource list \[options\] このコマンドでは、​``​ で指定されたアセットのアセットポータルのリソースをリストします。 引数 ​`assetIdentifier`​ は、​`[group_id]//`​ の形式にする必要があります。 `group_id`​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。
このコマンドでは、デフォルトでパブリッシュ済みのリソースをリストします。
--draft​ オプションを使用して、アセットポータルからドラフトリソースをリストできます。
このコマンドでは、デフォルトの ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ オプション以外に、アセットポータルでパブリッシュされていないリソースをリストするために ​`--draft`​ オプションも使用できます。 ## [](#exchange-asset-resource-download)exchange asset resource download \> exchange asset resource download \[options\] このコマンドでは、​``​ で指定されたパブリッシュ済みリソースを ​``​ で指定されたアセットのアセットポータルから ​``​ で指定されたファイルにダウンロードします。 引数 ​`assetIdentifier`​ は、​`[group_id]//`​ の形式にする必要があります。 `group_id`​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。 引数 ​``​ はパブリッシュ済みリソースである必要があります。 すべてのパブリッシュ済みリソースは ​[asset resource list](#exchange-asset-resource-list)​ コマンドを使用してリストできます。
このコマンドでは、パブリッシュ済みリソースのみがサポートされています。
このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#exchange-asset-resource-delete)exchange asset resource delete \> exchange asset resource delete \[options\] このコマンドでは、​`resourcePath`​ が削除されている新しいポータルをパブリッシュすることで、​``​ で指定されたリソースを ​``​ で指定されたアセットのアセットポータルから削除します。 引数 ​``​ は、​`[group_id]//`​ の形式にする必要があります。 `group_id`​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。 引数 ​``​ はパブリッシュ済みリソースである必要があります。 すべてのパブリッシュ済みリソースは ​[asset resource list](#exchange-asset-resource-list)​ コマンドを使用してリストできます。
このコマンドでは、操作の一環としてすべてのアクティブなドラフトをパブリッシュします。
このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 # Exchange アセットの CLI
コマンド 説明

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

既存の Exchange アセットの変更可能なデータを変更する

Exchange アセットを変更する

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

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

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

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

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

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

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

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

Exchange アセットをコピーする

Exchange のアセットを削除する

アセットを非推奨にする

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

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

アセットポータルにリソースをアップロードする

アセットポータルでパブリッシュ済みのリソースをリストする

アセットポータルからリソースをダウンロードする

アセットポータルからリソースを削除する

既存アセットの状況を変更する

Exchange コマンドは現在、GovCloud では使用できません。
## [](#exchange-asset-upload)exchange:asset:upload \> exchange:asset:upload \[flags\] このコマンドでは、​``​ で渡される ID を使用して、rest-api、soap-api、http-api、raml-fragment、custom、app、template、example、policy、extension、external-library、connector アセット、または ruleset をアップロードします。 _assetIdentifier_​ 引数には次の形式を使用します。 `([​_groupID_​]/)​_assetID_​/_version_` _group\_id_ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。
フラグ 説明

--name

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

次に例を示します。

exchange:asset:upload --name "Raml Asset" --description "RAML" --properties='{"apiVersion":"v1", "mainFile": "api.raml"}' --files='{"raml.zip":"​/file-path/raml.zip"}'

--description

アセットの説明

--properties

アセットプロパティ

次に例を示します。

  • --properties='{"mainFile":"main.raml"}'

  • --properties='{"apiVersion":"v1"}'

  • --properties='{"assetLink":"http://api.com"}'

  • --properties='{"mainFile":"main.raml","apiVersion":"v1","assetLink":"http://api.com","contactEmail":"api@mulesoft.com","contactName":"Marc"}'

--files

アセットファイル (​classifier.packaging​ または ​packaging​ とそのファイルパスとして識別される。) 例: --files='{"oas.zip":"​/my-api.raml"}'

複数のファイルを送信するには通常、同じフラグを複数回使用します。

--files='{"oas.zip": "my-demo-oas.zip"}' --files='{"custom.zip": "~/my-custom-file.zip"}'​

ルールセットを含むルールセットドキュメントをアップロードする場合は例外です。分類子とパッケージ化オプションの両方のセットを 1 つの ​--files​ フラグに入力する必要があります。

--files='{"ruleset.yaml":"/myRulesetFolder/mynewruleset.yaml","docs.zip":"/myRulesetFolder/ruleset.doc.zip"}'

例:

POM ファイルと RAML 仕様をアップロードする:

exchange:asset:upload --files'{"pom.xml": "directory/pom-file.xml"}' --files='{"raml.raml": "./my-api.raml"}'​

ルールセットとそのドキュメントをアップロードする:

anypoint-cli-v4 exchange asset upload my-auth-best-practices/1.0.0 --name "My Best Practices Ruleset" --description "This ruleset enforces my best practices for APIs." --files='{"ruleset.yaml":"/myRulesetFolder/mynewruleset.yaml","docs.zip":"/myRulesetFolder/ruleset.doc.zip"}'

--type

アセットタイプ

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

サポートされる値:

  • rest-api​

  • soap-api​

  • http-api​

  • raml-fragment​

  • custom​

  • connector​

  • template​

  • example​

  • policy​

  • app​

  • extension​

  • external-library​

  • ruleset​

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

アセットタイプに応じて、次のような分類子の値があります。

  • REST API

    • oas​ (​zip​、​yaml​、または ​json​ をパッケージとして使用)

    • raml​ (​zip​ または ​raml​ をパッケージとして使用)

  • RAML フラグメント

    • raml-fragment​ (​zip​ または ​raml​ をパッケージとして使用)

  • SOAP API

    • wsdl​ (​zip​、​wsld​、または ​xml​ をパッケージとして使用)

  • Custom (カスタム)

    • custom​

    • docs​ (​doc.zip​ をパッケージとして使用)

  • アプリケーション

    • mule-application​ (​jar​ をパッケージとして使用)

  • ポリシー

    • mule-policy​ (​jar​ をパッケージとして使用) + ​policy-definition​ (​yaml​ をパッケージとして使用)

  • 例

    • mule-application-example​ (​jar​ をパッケージとして使用)

  • Template (テンプレート)

    • mule-application-template​ (​jar​ をパッケージとして使用)

  • Extension (拡張子)

    • mule-plugin​ (​jar​ をパッケージとして使用)

  • Connector (コネクタ)

    • studio-plugin​ (​zip​ をパッケージとして使用) + 分類子がなくパッケージ ​jar​ を使用するファイル

  • 外部ライブラリ

    • external-library​ (​jar​ をパッケージとして使用)

  • ルールセット

    • ruleset​ (​zip​ または ​yaml​ をパッケージとして使用)

--categories

カテゴリ (値は JSON 形式の文字列である必要があります)

'{"key": "value"}'

次に例を示します。

'{"Department": "IT"}'

--fields

項目 (値は JSON 形式の文字列である必要があります)

'{"key": "value"}'

次に例を示します。

'{"releaseDate": "2020-01-01T20:00:00.000Z"}'

--keywords

キーワード (カンマ区切り)

次に例を示します。

raml,rest-api,someKeyword​

--tags

タグ (カンマ区切り)

次に例を示します。

api,tag1,tag2​

--dependencies

アセットの連動関係 (カンマ区切り)

次に例を示します。

groupID:assetID:version,groupID2:assetID:version​

--status

アセットの状況

サポートされる値:

  • development​

  • published​

デフォルト値:

  • published​

## [](#exchange-asset-mutableDataUpload)exchange:asset:mutableDataUpload \> exchange:asset:mutableDataUpload \[flags\] このコマンドでは、タグ、カテゴリ、項目、ドキュメントを含む作成済みの変更可能なデータを変更します。 _assetIdentifier_​ 引数には次の形式を使用します。 `[​__​]/​__​/__` _group\_id_ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。
フラグ 説明 例

--docs

ドキュメントファイル。(「zip」ファイルパスを指定する必要があります。例: "--docs /…​/file-path/docs.zip")

--docs /Users/llucas/Desktop/examples/docs.zip --tags "tag1,tag2" --categories.beach sun --fields.central park fa7b266c-3817-4cbb-ae49-7f3cc6c8cd9e/asset-id/1.0.0​

--categories

カテゴリ

--categories.someKey value​

--categories.anotherKey anotherValue​

--fields

項目

--fields.someKey value​

--fields.anotherKey anotherValue​

--tags

タグ (カンマ区切り)

--tags api,tag1,tag2​

## [](#exchange-asset-updateStatus)exchange:asset:updateStatus \> exchange:asset:updateStatus \[flags\] このコマンドは、作成済みのアセットの状況を変更します。 _assetIdentifier_​ 引数には次の形式を使用します。 `[​__​]/​__​/__` _group\_id_ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。
フラグ 説明 例

--status

アセットの状況

サポートされる値:

  • published​

  • deprecated

--status deprecated​

有効な移行:
移行元 移行先

development

published

published

deprecated

deprecated

published

`published`​ 状態は ​`stable`​ 状態に対応することに注意してください ## [](#exchange-asset-modify)exchange:asset:modify \> exchange:asset:modify \[flags\] このコマンドは、​``​ で識別される Exchange アセットを変更します。 引数 ​`assetIdentifier`​ は、​`([group_id]/)/`​ の形式にする必要があります。 `group_id`​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。 このコマンドでは、デフォルトの ​`--help`​ フラグ以外に次のフラグも受け入れます。
フラグ 説明 例

--name

新しいアセット名 .2+<.<

--name newName --tags test,sample

--tags

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

--tags tag1,tag2

## [](#exchange-asset-download)exchange:asset:download \> exchange:asset:download \[flags\] このコマンドは、​``​ で識別される Exchange アセットを ​``​ で渡されるディレクトリにダウンロードします。 引数 ​`assetIdentifier`​ は、​`([group_id]/)/`​ の形式にする必要があります。 `group_id`​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#exchange-asset-list)exchange:asset:list \> exchange:asset:list \[flags\] \[searchText\] このコマンドは、Exchange のすべてのアセットをリストします。
searchText でキーワードを指定して、それらの特定のキーワードが含まれる API のみが結果に表示されるように制限できます。
このコマンドでは、デフォルトの ​`--help`​ フラグ以外に次のフラグも受け入れます。
フラグ 説明 例

--limit

取得する結果の数

--limit 2

--offset

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

--offset 3

--organizationId

組織 ID で絞り込む

--organizationId a12b3c45-de6f-789g-hi01-j2klm3nop4q5

--output

応答形式を指定する。

--output json​

## [](#exchange-asset-page-download)exchange:asset:page:download \> exchange:asset:page:download \[flags\] \[pageName\] このコマンドは、​``​ で識別される Exchange アセットの ​``​ で指定される説明ページを ​``​ で渡されるディレクトリにダウンロードします。 \[pageName\] が指定されていない場合、このコマンドはすべてのページをダウンロードします。
このコマンドでは、パブリッシュ済みページのみがサポートされています。
引数 ​`assetIdentifier`​ は、​`([group_id]/)/`​ の形式にする必要があります。 `group_id`​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。 説明ページは、マークダウン形式でダウンロードされます。​`name`​ が指定されていない場合、すべてのページがダウンロードされます。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#exchange-asset-page-modify)exchange:asset:page:modify \> exchange:asset:page:modify \[flags\] このコマンドは、​``​ で識別される Exchange アセットの ​``​ で指定される説明ページを変更します。
このコマンドでは、パブリッシュ済みページのみがサポートされています。
引数 ​`assetIdentifier`​ は、​`([group_id]/)/`​ の形式にする必要があります。 `group_id`​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。 このコマンドでは、デフォルトの ​`--help`​ フラグ外に、新しいアセットページ名を設定する ​`--name`​ フラグも使用できます。 ## [](#exchange-asset-page-upload)exchange:asset:page:upload \> exchange:asset:page:upload \[flags\] このコマンドは、​``​ で指定される名前を使用して、アセットの説明ページを ​``​ で渡されるパスから ​``​ で識別される Exchange アセットにアップロードします。 ページの名前を「home」にすると、アップロードされたページが Exchange アセットのメイン説明ページになります。
このコマンドでは、操作の一環としてすべてのアクティブなドラフトをパブリッシュします。
引数 ​`assetIdentifier`​ は、​`[group_id]//`​ の形式にする必要があります。 `group_id`​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#exchange-asset-page-update)exchange:asset:page:update \> exchange:asset:page:update \[flags\] このコマンドでは、​``​ で指定される名前を使用して、アセットの説明ページのコンテンツを ​``​ で渡されるパスから ​``​ で識別される Exchange アセットに更新します。 ページの名前を「home」にすると、更新されたページが Exchange アセットのメイン説明ページになります。
このコマンドでは、操作の一環としてすべてのアクティブなドラフトをパブリッシュします。
引数 ​`assetIdentifier`​ は、​`[group_id]//`​ の形式にする必要があります。 `group_id`​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#exchange-asset-page-delete)exchange:asset:page:delete \> exchange:asset:page:delete \[flags\] このコマンドは、​``​ で識別されるアセットの ​``​ で指定される説明ページを削除します。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
このコマンドでは、パブリッシュ済みページのみがサポートされています。
引数 ​`assetIdentifier`​ は、​`([group_id]/)/`​ の形式にする必要があります。 `group_id`​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#exchange-asset-page-list)exchange:asset:page:list \> exchange:asset:page:list このコマンドは、​``​ で渡されるアセットのすべてのページをリストします。 引数 ​`assetIdentifier`​ は、​`([group_id]/)/`​ の形式にする必要があります。 `group_id`​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。
このコマンドでは、パブリッシュ済みページのみがサポートされています。
このコマンドには ​`--output`​ フラグを使用できます。​`--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 このコマンドでは、デフォルトのフラグ ​`--help`​ も受け入れます。 ## [](#exchange-asset-copy)exchange:asset:copy \> exchange:asset:copy \[flags\] このコマンドは、​``​ から ​``​ に Exchange アセットをコピーします。 引数 ​``​ および ​``​ は、​`([group_id]/)/`​ の形式にする必要があります。 `group_id`​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。 このコマンドはデフォルトのフラグ ​`--help`​ と、次のフラグを受け入れます。
フラグ 説明 例

--targetOrganizationId

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

--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 \> exchange:asset:delete \[flags\] このコマンドは、​``​ で渡される Exchange アセットを削除します。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
引数 ​`assetIdentifier`​ は、​`([group_id]/)/`​ の形式にする必要があります。 `group_id`​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#exchange-asset-deprecate)exchange:asset:deprecate \> exchange:asset:deprecate このコマンドは、​``​ で渡されるアセットを非推奨にします。 引数 ​`assetIdentifier`​ は、​`([group_id]/)/`​ の形式にする必要があります。 `group_id`​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#exchange-asset-undeprecate)exchange:asset:undeprecate \> exchange:asset:undeprecate このコマンドは、​``​ で渡されるアセットの非推奨を解除します。 引数 ​`assetIdentifier`​ は、​`([group_id]/)/`​ の形式にする必要があります。 `group_id`​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#exchange-asset-describe)exchange:asset:describe \> exchange:asset:describe このコマンドは、​``​ で渡されるアセットの情報を表示します。 引数 ​`assetIdentifier`​ は、​`([group_id]/)/`​ の形式にする必要があります。 `group_id`​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。 このコマンドには ​`--output`​ フラグを使用できます。​`--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 このコマンドでは、デフォルトのフラグ ​`--help`​ も受け入れます。 ## [](#exchange-asset-resource-upload)exchange:asset:resource:upload \> exchange:asset:resource:upload \[flags\] このコマンドでは、​``​ で指定されたリソースを ​``​ で説明されるアセットポータルのページにアップロードします。 このコマンドは、​``​ アセットの任意のページに使用できます。 ``​ でサポートされるファイルの拡張子は、​`jpeg`​、​`jpg`​、​`jpe`​、​`gif`​、​`bmp`​、​`png`​、​`webp`​、​`ico`​、​`svg`​、​`tiff`​、​`tif`​。 引数 ​`assetIdentifier`​ は、​`[group_id]//`​ の形式にする必要があります。 `group_id`​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。 成功した出力コマンドはマークダウンコードスニペットになります。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#exchange-asset-resource-list)exchange:asset:resource:list \> exchange:asset:resource:list \[flags\] このコマンドでは、​``​ で指定されたアセットのアセットポータルのリソースをリストします。 引数 ​`assetIdentifier`​ は、​`[group_id]//`​ の形式にする必要があります。 `group_id`​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。
このコマンドでは、デフォルトでパブリッシュ済みのリソースをリストします。
--draft​ フラグを使用して、アセットポータルからドラフトリソースをリストできます。
このコマンドは、アセットポータル内のパブリッシュされていないリソースをリストする ​`--draft`​ フラグを受け入れます。 このコマンドには ​`--output`​ フラグを使用できます。​`--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 このコマンドでは、デフォルトのフラグ ​`--help`​ も受け入れます。 ## [](#exchange-asset-resource-download)exchange:asset:resource:download \> exchange:asset:resource:download \[flags\] このコマンドでは、​``​ で指定されたパブリッシュ済みリソースを ​``​ で指定されたアセットのアセットポータルから ​``​ で指定されたファイルにダウンロードします。 引数 ​`assetIdentifier`​ は、​`[group_id]//`​ の形式にする必要があります。 `group_id`​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。 引数 ​``​ はパブリッシュ済みリソースである必要があります。 すべてのパブリッシュ済みリソースは ​[asset resource list](#exchange:asset:resource:list)​ コマンドを使用してリストできます。
このコマンドでは、パブリッシュ済みリソースのみがサポートされています。
このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#exchange-asset-resource-delete)exchange:asset:resource:delete \> exchange:asset:resource:delete \[flags\] このコマンドでは、​`resourcePath`​ が削除されている新しいポータルをパブリッシュすることで、​``​ で指定されたリソースを ​``​ で指定されたアセットのアセットポータルから削除します。 引数 ​``​ は、​`[group_id]//`​ の形式にする必要があります。 `group_id`​ が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。 引数 ​``​ はパブリッシュ済みリソースである必要があります。 すべてのパブリッシュ済みリソースは ​[asset resource list](#exchange:asset:resource:list)​ コマンドを使用してリストできます。
このコマンドでは、操作の一環としてすべてのアクティブなドラフトをパブリッシュします。
このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#関連情報)関連情報 - [API カタログ CLI を使用した API の自動カタログ化](https://docs.mulesoft.com/jp/exchange/apicat-about-api-catalog-cli) # Runtime Fabric インスタンスの CLI
コマンド 説明

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

## [](#runtime-mgr-rtf-list)runtime-mgr rtf list \> runtime-mgr rtf list \[options\] このコマンドは、使用可能な Runtime Fabric インスタンスをリストします。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 コマンドラインを使用した Runtime Fabric インスタンスの管理については、​[「サポートされている rtfctl コマンド」](https://docs.mulesoft.com/runtime-fabric/latest/install-rtfctl#supported-commands)​を参照してください。 # Runtime Fabric でアプリケーションを管理するための CLI これらのコマンドを使用して、Runtime Fabric でアプリケーションを管理します。
コマンド 説明

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

Exchange アプリケーションを使用して指定された対象にアプリケーションをデプロイし、指定されたランタイムバージョンを実行する

アプリケーションの情報を表示する

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

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

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

デプロイ済みのアプリケーションを修正する

停止中のアプリケーションを開始する

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

仕様のアプリケーションのログを追跡する

## [](#runtime-mgr-application-delete)runtime-mgr application delete \> runtime-mgr application delete \[options\] ``​ で指定された実行中のアプリケーションを削除します。この ID を取得するには、​`runtime-mgr application list`​ コマンドを実行します。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-application-deploy)runtime-mgr application deploy \> runtime-mgr application deploy \[options\] ``​ で指定されたアプリケーションを、次のオプションを使用して指定されたデプロイメント対象にデプロイします。
値 説明 例

ArtifactId

Exchange から取得したアプリケーションのアーティファクト ID。

mule-test-plugin

deploymentTargetID

デプロイメント対象の ID。
この ID は、Runtime Manager から直接取得できます。

app.runetime

name

デプロイするアプリケーションの名前。

testCloudhub2app

runtimeVersion

デプロイメント対象のランタイムバージョン。

1.0.1​

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

assetVersion

使用する Exchange アプリケーションのバージョン。
デフォルト: 最新のアプリケーションバージョン

2.0.4

clustered

クラスタリングされたノードを有効にします。少なくとも 2 つのレプリカが必要です。
デフォルト:.disabled
サポートされている値: true​、​false

false

disableAmLogForwarding

Anypoint Monitoring へのアプリケーションログの転送を無効にします。
デフォルト: enabled
サポートされている値: true​、​false

true

forwardSslSession

SSL セッション転送を有効にします。
デフォルト: disabled
値: true​、​false

false

groupId

デプロイするアセットの ID。
デフォルト: 選択済み組織 ID

org.mule.test

lastMileSecurity

Last Mile セキュリティを有効にします。
デフォルト: disabled
サポートされている値: true​、​false

true

objectStoreV2

Object Store v2 を有効にします。
デフォルト: disabled
サポートされている値: true​、​false

true

pathRewrite

アプリケーションの HTTP リスナーで要求されるベースパスを提供します。
形式: /​ で始まる必要があります

/http://localhost:3000

property

プロパティを設定します。
形式: name:value

testproperty:true

propertiesFile

すべてのプロパティを選択済みファイルの値に置き換えます。
形式: 1 行以上の ​name:value​ 形式

/Users/mule/Documents/properties.txt

publicEndpoints

公開インターネット経由で到達するエンドポイントを提供します。
形式: カンマ区切りでスペースなし

my-superapp-example:/status?limit=10

replicas

レプリカの数。​0​ より大きい必要があります。
デフォルト: 1

2

replicaSize

vCore のレプリカのサイズ。
デフォルト: 0.1

0.5

scopeLoggingConfig

スコープログ記録を定義します。
形式: scopeName: logLevel​、カンマ区切りでスペースなし

testscope1:WARN,testscope2:DEBUG

scopeLoggingConfigFile

ファイルをアップロードしてスコープログ記録を定義します。
形式: 1 行に 1 タプル、スタイル: {scope: scopeName, logLevel: logLevelType}​ を ​{} ​()​ または ​[]​ で囲む

/Users/mule/Documents/cert.txt

updateStrategy

使用される戦略を更新します。
デフォルト: rolling

recreate

## [](#runtime-mgr-application-describe)runtime-mgr application describe \> runtime-mgr application describe \[options\] ``​ で指定されたアプリケーションに関する情報を表示します。この ID を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-application-describe-json)runtime-mgr application describe-json \> runtime-mgr application describe-json \[options\] ``​ で指定されたアプリケーションから未加工の JSON 応答を表示します。この ID を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-application-download-logs)runtime-mgr application download-logs \> runtime-mgr application download-logs \[options\] ``​ で指定された仕様から、選択したディレクトリに ​``​ で指定されたアプリケーションのログをダウンロードします。 ``​ を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 ``​ を取得するには、​`runtime-mgr application describe`​ コマンドを実行します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-application-list)runtime-mgr application list \> runtime-mgr application list \[options\] 組織内のすべてのアプリケーションをリストします。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-application-modify)runtime-mgr application modify \> runtime-mgr application modify \[options\] ``​ で指定された既存のアプリケーションの設定を更新します。 ``​ を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 このコマンドでは、デフォルトの ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ オプション以外に次のオプションも使用できます。
値 説明 例

ArtifactId

Exchange から取得したアプリケーションの ID。

mule-maven-plugin

assetVersion

使用する Exchange アプリケーションのバージョン。
デフォルト: 最新のアプリケーションバージョン

2.0.4

clustered

クラスタリングされたノードを有効にします。少なくとも 2 つのレプリカが必要です。
デフォルト: disabled
サポートされている値: true​、​false

false

disableAmLogForwarding

Anypoint Monitoring へのアプリケーションログの転送を無効にします。
デフォルト: enabled
サポートされている値: true​、​false

true

forwardSslSession

SSL セッション転送を有効にします。
デフォルト: disabled
値: true​、​false

false

groupId

デプロイするアセットの ID。
デフォルト: 選択済み組織 ID。

org.mule.testgroup

lastMileSecurity

Last Mile セキュリティを有効にします。
デフォルト: disabled
サポートされている値: true​、​false

true

objectStoreV2

Object Store v2 を有効にします。
デフォルト: disabled
サポートされている値: true​、​false

true

pathRewrite

アプリケーションの HTTP リスナーで要求されるベースパスを提供します。
形式: /​ で始まる必要があります

/http://localhost:3000​.

property

プロパティを設定します。
形式: name:value

testproperty:true

propertiesFile

すべてのプロパティを選択済みファイルの値に置き換えます。
形式: 1 行以上の ​name:value​ 形式

/Users/mule/Documents/properties.txt

publicEndpoints

公開インターネット経由で到達するエンドポイントを提供します。
形式: カンマ区切りでスペースなし

my-superapp-example: /status?limit=10

replicas

レプリカの数。​0​ より大きい必要があります。
デフォルト: 1

2

replicaSize

vCore のレプリカのサイズ。
デフォルト: 0.1

0.5

runtimeVersion

デプロイメント対象のランタイムバージョン。

1.0.1

scopeLoggingConfig

スコープログ記録を定義します。
形式: scopeName: logLevel​、カンマ区切りでスペースなし

testscope1:WARN,testscope2:DEBUG

scopeLoggingConfigFile

ファイルをアップロードしてスコープログ記録を定義します。
形式: 1 行に 1 タプル、スタイル: {scope: scopeName, logLevel: logLevelType}​ を ​{} ​()​ または ​[]​ で囲む

/Users/mule/Documents/cert.txt

updateStrategy

使用される戦略を更新します。
デフォルト: rolling

recreate​

## [](#runtime-mgr-application-start)runtime-mgr application start \> runtime-mgr application start \[options\] ``​ で指定されたアプリケーションの実行を開始します。この ID を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 このコマンドでは、デフォルトのオプション ​`--help`​ のみを受け入れます。 ## [](#runtime-mgr-application-stop)runtime-mgr application stop \> runtime-mgr application stop \[options\] ``​ で指定されたアプリケーションの実行を停止します。この ID を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 このコマンドでは、デフォルトのオプション ​`--help`​ のみを受け入れます。 ## [](#runtime-mgr-application-tail-logs)runtime-mgr application tail-logs \> runtime-mgr:application:tail-logs \[options\] ``​ で指定された仕様から、​``​ で指定されたアプリケーションのアプリケーションログを追跡します。 ``​ を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 ``​ を取得するには、​`runtime-mgr application describe`​ コマンドを実行します。 このコマンドでは、デフォルトのオプション ​`--help`​ のみを受け入れます。 \[\[runtime-mgr-application-delete\]\] == runtime-mgr application delete \> runtime-mgr application delete \[options\] ``​ で指定された実行中のアプリケーションを削除します。この ID を取得するには、​`runtime-mgr application list`​ コマンドを実行します。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
このコマンドでは、デフォルトのオプション ​`--help`​ のみを受け入れます。 ## [](#runtime-mgr-application-describe)runtime-mgr application describe \> runtime-mgr application describe \[options\] ``​ で指定されたアプリケーションに関する情報を表示します。この ID を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 このコマンドでは、デフォルトのオプション ​`--help`​ のみを受け入れます。 ## [](#runtime-mgr-application-describe-json)runtime-mgr application describe-json \> runtime-mgr application describe-json \[options\] ``​ で指定されたアプリケーションから未加工の JSON 応答を表示します。この ID を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 このコマンドでは、デフォルトのオプション ​`--help`​ のみを受け入れます。 ## [](#runtime-mgr-application-download-logs)runtime-mgr application download-logs \> runtime-mgr application download-logs \[options\] ``​ で指定された仕様から、選択したディレクトリに ​``​ で指定されたアプリケーションのログをダウンロードします。 ``​ を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 ``​ を取得するには、​`runtime-mgr application describe`​ コマンドを実行します。 このコマンドでは、デフォルトのオプション ​`--help`​ のみを受け入れます。 ## [](#runtime-mgr-application-list)runtime-mgr application list \> runtime-mgr application list \[options\] 組織内のすべてのアプリケーションをリストします。 このコマンドでは、デフォルトのオプション ​`--help`​ のみを受け入れます。 ## [](#runtime-mgr-application-modify)runtime-mgr application modify \> runtime-mgr application modify \[options\] ``​ で指定された既存のアプリケーションの設定を更新します。 ``​ を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 このコマンドでは、デフォルトの ​`--help`​ オプション以外に次のオプションも使用できます。
値 説明 例

ArtifactId

Exchange から取得したアプリケーションの ID。

mule-maven-plugin

assetVersion

使用する Exchange アプリケーションのバージョン。
デフォルト: 最新のアプリケーションバージョン

2.0.4

clustered

クラスタリングされたノードを有効にします。少なくとも 2 つのレプリカが必要です。
デフォルト: disabled
サポートされている値: true​、​false

false

disableAmLogForwarding

Anypoint Monitoring へのアプリケーションログの転送を無効にします。
デフォルト: enabled
サポートされている値: true​、​false

true

forwardSslSession

SSL セッション転送を有効にします。
デフォルト: disabled
値: true​、​false

false

groupId

デプロイするアセットの ID。
デフォルト: 選択済み組織 ID。

org.mule.testgroup

lastMileSecurity

Last Mile セキュリティを有効にします。
デフォルト: disabled
サポートされている値: true​、​false

true

objectStoreV2

Object Store v2 を有効にします。
デフォルト: disabled
サポートされている値: true​、​false

true

pathRewrite

アプリケーションの HTTP リスナーで要求されるベースパスを提供します。
形式: /​ で始まる必要があります

/http://localhost:3000​.

property

プロパティを設定します。
形式: name:value

testproperty:true

propertiesFile

すべてのプロパティを選択済みファイルの値に置き換えます。
形式: 1 行以上の ​name:value​ 形式

/Users/mule/Documents/properties.txt

publicEndpoints

公開インターネット経由で到達するエンドポイントを提供します。
形式: カンマ区切りでスペースなし

my-superapp-example: /status?limit=10

replicas

レプリカの数。​0​ より大きい必要があります。
デフォルト: 1

2

replicaSize

vCore のレプリカのサイズ。
デフォルト: 0.1

0.5

runtimeVersion

デプロイメント対象のランタイムバージョン。

1.0.1

scopeLoggingConfig

スコープログ記録を定義します。
形式: scopeName: logLevel​、カンマ区切りでスペースなし

testscope1:WARN,testscope2:DEBUG

scopeLoggingConfigFile

ファイルをアップロードしてスコープログ記録を定義します。
形式: 1 行に 1 タプル、スタイル: {scope: scopeName, logLevel: logLevelType}​ を ​{} ​()​ または ​[]​ で囲む

/Users/mule/Documents/cert.txt

updateStrategy

使用される戦略を更新します。
デフォルト: rolling

recreate​

## [](#runtime-mgr-application-start-2)runtime-mgr application start \> runtime-mgr application start \[options\] ``​ で指定されたアプリケーションの実行を開始します。この ID を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-application-stop-2)runtime-mgr application stop \> runtime-mgr application stop \[options\] ``​ で指定されたアプリケーションの実行を停止します。この ID を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-application-tail-logs-2)runtime-mgr application tail-logs \> runtime-mgr application tail-logs \[options\] ``​ で指定された仕様から、​``​ で指定されたアプリケーションのアプリケーションログを追跡します。 ``​ を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 ``​ を取得するには、​`runtime-mgr application describe`​ コマンドを実行します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 # Runtime Fabric でアプリケーションを管理するための CLI これらのコマンドを使用して、Runtime Fabric でアプリケーションを管理します。
コマンド 説明

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

アプリケーションの情報を表示する

Exchange アプリケーションを使用して指定された対象にアプリケーションをデプロイし、指定されたランタイムバージョンを実行する

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

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

デプロイ済みのアプリケーションを修正する

停止中のアプリケーションを開始する

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

仕様のアプリケーションのログを追跡する

## [](#runtime-mgr-application-delete)runtime-mgr:application:delete \> runtime-mgr:application:delete \[flags\] ``​ で指定された実行中のアプリケーションを削除します。この ID を取得するには、​`runtime-mgr application list`​ コマンドを実行します。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgr-application-describe)runtime-mgr:application:describe \> runtime-mgr:application:describe \[flags\] ``​ で指定されたアプリケーションに関する情報を表示します。この ID を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 このコマンドには ​`--output`​ フラグを使用できます。​`--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 このコマンドでは、デフォルトのフラグ ​`--help`​ も受け入れます。 ## [](#runtime-mgr-application-deploy)runtime-mgr:application:deploy \> runtime-mgr:application:deploy \[flags\] ``​ で指定されたアプリケーションを、次のオプションを使用して指定されたデプロイメント対象にデプロイします。
値 説明 例

--artifactId

Exchange から取得したアプリケーションのアーティファクト ID。

--artifactId mule-test-plugin

--deploymentTargetId

デプロイメント対象の ID。
この ID は、Runtime Manager から直接取得できます。

--deploymentTargetId 7de39400-a2b3-0a93-b2349-23eacbca9e322

--name

デプロイするアプリケーションの名前。

--name testcloudhub2app

--runtimeVersion

デプロイメント対象のランタイムバージョン。

--runtimeVersion 4.4.0

--secureProperty

暗号化されたプロパティを設定します。

--secureProperty secureTestProperty:true​

このコマンドでは、デフォルトの ​`--help`​ フラグ以外に次のフラグも使用できます。
フラグ 説明 例

--assetVersion

使用する Exchange アプリケーションのバージョン。
デフォルト: 最新のアプリケーションバージョン

--assetVersion 2.0.4

--[no-]clustered

クラスタリングされたノードを有効にします。少なくとも 2 つのレプリカが必要です。
デフォルト:.disabled

--no-clustered

--[no-]disableAmLogForwarding

Anypoint Monitoring へのアプリケーションログの転送を無効にします。
デフォルト: enabled

--disableAmLogForwarding

--[no-]forwardSslSession

SSL セッション転送を有効にします。
デフォルト: disabled

--no-forwardSslSession

--groupId

デプロイするアセットの ID。
デフォルト: 選択済み組織 ID

--groupId org.mule.test

--[no-]lastMileSecurity

Last Mile セキュリティを有効にします。
デフォルト: disabled

--no-lastMileSecurity

--[no-]objectStoreV2

Object Store v2 を有効にします。
デフォルト: disabled

--no-objectStoreV2

--pathRewrite

アプリケーションの HTTP リスナーで要求されるベースパスを提供します。
形式: /​ で始まる必要があります

--pathRewrite /http://localhost:3000

--property

プロパティを設定します。
形式: name:value

--property testproperty:true

--propertiesFile

すべてのプロパティを選択済みファイルの値に置き換えます。
形式: 1 行以上の ​name:value​ 形式

--propertiesFile /Users/mule/Documents/properties.txt

--publicEndpoints

公開インターネット経由で到達するエンドポイントを提供します。
形式: カンマ区切りでスペースなし

--publicEndpoints my-superapp-example:/status?limit=10

--replicas

レプリカの数。​0​ より大きい必要があります。
デフォルト: 1

--replicas 2

--replicaSize

vCore のレプリカのサイズ。
デフォルト: 0.1

--replicaSize 0.5

--scopeLoggingConfig

スコープログ記録を定義します。
形式: scopeName: logLevel​、カンマ区切りでスペースなし

--scopeLoggingConfig testscope1:WARN,testscope2:DEBUG

--scopeLoggingConfigFile

ファイルをアップロードしてスコープログ記録を定義します。
形式: 1 行に 1 タプル、スタイル: {scope: scopeName, logLevel: logLevelType}​ を ​{} ​()​ または ​[]​ で囲む

--scopeLoggingConfigFile /Users/mule/Documents/cert.txt

--updateStrategy

使用される戦略を更新します。
デフォルト: rolling

--updateStrategy recreate

このコマンドには複数オプションのフラグがあります。コマンドで複数オプションのフラグを使用する場合は、フラグの前にパラメーターを置くか、パラメーターの前に ​`-- `​ (2 つのダッシュの後にスペース) を使用します。

Mule 4.5 以降、MuleSoft は Edge と長期サポート (LTS) という 2 つの新しいリリースチャネルを導入します。新しいリリースチャネルの Mule Runtime バージョン設定スキーマは次のとおりです。

メジャー[数値] .マイナー[数値] . パッチ[数値] : ビルド[数値] チャネル[Edge の場合は e、LTS の場合はなし]

これらの値の例としては、Edge の場合は ​4.5.0:1e​、LTS の場合は ​4.6.0:1​ となります。

詳細は、Edge and LTS Releases for Muleを参照してください。

## [](#runtime-mgr-application-download-logs)runtime-mgr:application:download-logs \> runtime-mgr:application:download-logs \[flags\] ``​ で指定された仕様から、選択したディレクトリに ​``​ で指定されたアプリケーションのログをダウンロードします。 ``​ を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 ``​ を取得するには、​`runtime-mgr application describe`​ コマンドを実行します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgr-application-list)runtime-mgr:application:list \> runtime-mgr:application:list \[flags\] 組織内のすべてのアプリケーションをリストします。 このコマンドには ​`--output`​ フラグを使用できます。​`--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 このコマンドでは、デフォルトのフラグ ​`--help`​ を受け入れます。 ## [](#runtime-mgr-application-modify)runtime-mgr:application:modify \> runtime-mgr:application:modify \[flags\] ``​ で指定された既存のアプリケーションの設定を更新します。 ``​ を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 このコマンドでは、デフォルトの ​`--help`​ フラグ以外に次のフラグも使用できます。
フラグ 説明 例

--artifactId

Exchange から取得したアプリケーションの ID。

--artifactId mule-maven-plugin

--assetVersion

使用する Exchange アプリケーションのバージョン。
デフォルト: 最新のアプリケーションバージョン

--assetVersion 2.0.4

--[no-]clustered

クラスタリングされたノードを有効にします。少なくとも 2 つのレプリカが必要です。
デフォルト: disabled

--no-clustered

--[no-]disableAmLogForwarding

Anypoint Monitoring へのアプリケーションログの転送を無効にします。
デフォルト: enabled

--disableAmLogForwarding

--[no-]forwardSslSession

SSL セッション転送を有効にします。
デフォルト: disabled

--no-forwardSslSession

--groupId

デプロイするアセットの ID。
デフォルト: 選択済み組織 ID。

--groupId org.mule.testgroup

--[no-]lastMileSecurity

Last Mile セキュリティを有効にします。
デフォルト: disabled

--no-lastMileSecurity

--[no-]objectStoreV2

Object Store v2 を有効にします。
デフォルト: disabled

--no-objectStoreV2

--pathRewrite

アプリケーションの HTTP リスナーで要求されるベースパスを提供します。
形式: /​ で始まる必要があります

--pathRewrite /http://localhost:3000​。

--property

プロパティを設定します。
形式: name:value

--property testproperty:true

--propertiesFile

すべてのプロパティを選択済みファイルの値に置き換えます。
形式: 1 行以上の ​name:value​ 形式

--propertiesFile /Users/mule/Documents/properties.txt

--publicEndpoints

公開インターネット経由で到達するエンドポイントを提供します。
形式: カンマ区切りでスペースなし

--publicEndpoints my-superapp-example: /status?limit=10

--replicas

レプリカの数。​0​ より大きい必要があります。
デフォルト: 1

--replicas 2

--replicaSize

vCore のレプリカのサイズ。
デフォルト: 0.1

--replicaSize 0.5

--runtimeVersion

デプロイメント対象のランタイムバージョン。

--runtimeVersion 4.4.0

--secureProperty

暗号化されたプロパティを設定します。

--secureProperty secureTestProperty:true

--scopeLoggingConfig

スコープログ記録を定義します。
形式: scopeName: logLevel​、カンマ区切りでスペースなし

--scopeLoggingConfig testscope1:WARN,testscope2:DEBUG

--scopeLoggingConfigFile

ファイルをアップロードしてスコープログ記録を定義します。
形式: 1 行に 1 タプル、スタイル: {scope: scopeName, logLevel: logLevelType}​ を ​{} ​()​ または ​[]​ で囲む

--scopeLoggingConfigFile /Users/mule/Documents/cert.txt

--updateStrategy

使用される戦略を更新します。
デフォルト: rolling

--updateStrategy recreate​

このコマンドには複数オプションのフラグがあります。コマンドで複数オプションのフラグを使用する場合は、フラグの前にパラメーターを置くか、パラメーターの前に ​`-- `​ (2 つのダッシュの後にスペース) を使用します。
## [](#runtime-mgr-application-start)runtime-mgr:application:start \> runtime-mgr:application:start \[flags\] ``​ で指定されたアプリケーションの実行を開始します。この ID を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgr-application-stop)runtime-mgr:application:stop \> runtime-mgr:application:stop \[flags\] ``​ で指定されたアプリケーションの実行を停止します。この ID を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgr-application-logs)runtime-mgr:application:logs \> runtime-mgr:application:logs \[flags\] ``​ で指定された仕様から、​``​ で指定されたアプリケーションのアプリケーションログを追跡します。 ``​ を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 ``​ を取得するには、​`runtime-mgr application describe`​ コマンドを実行します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgrapplicationdelete)runtime-mgr:application:delete \> runtime-mgr:application:delete \[flags\] ``​ で指定された実行中のアプリケーションを削除します。この ID を取得するには、​`runtime-mgr application list`​ コマンドを実行します。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgrapplicationdescribe)runtime-mgr:application:describe \> runtime-mgr:application:describe \[flags\] ``​ で指定されたアプリケーションに関する情報を表示します。この ID を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgrapplicationdownload-logs)runtime-mgr:application:download-logs \> runtime-mgr:application:download-logs \[flags\] ``​ で指定された仕様から、選択したディレクトリに ​``​ で指定されたアプリケーションのログをダウンロードします。 ``​ を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 ``​ を取得するには、​`runtime-mgr application describe`​ コマンドを実行します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgrapplicationlist)runtime-mgr:application:list \> runtime-mgr:application:list \[flags\] 組織内のすべてのアプリケーションをリストします。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgrapplicationmodify)runtime-mgr:application:modify \> runtime-mgr application modify \[flags\] ``​ で指定された既存のアプリケーションの設定を更新します。 ``​ を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 このコマンドでは、デフォルトの ​`--help`​ フラグ以外に次のフラグも使用できます。
フラグ 説明 例

--artifactId

Exchange から取得したアプリケーションの ID。

--artifactId mule-maven-plugin

--assetVersion

使用する Exchange アプリケーションのバージョン。
デフォルト: 最新のアプリケーションバージョン

-assetVersion 2.0.4

--[no-]clustered

クラスタリングされたノードを有効にします。少なくとも 2 つのレプリカが必要です。
デフォルト: disabled

--no-clustered

--[no-]disableAmLogForwarding

Anypoint Monitoring へのアプリケーションログの転送を無効にします。
デフォルト: enabled

--disableAmLogForwarding

--[no-]forwardSslSession

SSL セッション転送を有効にします。
デフォルト: disabled

--no-forwardSslSession

--groupId

デプロイするアセットの ID。
デフォルト: 選択済み組織 ID。

-groupId org.mule.testgroup

--[no-]lastMileSecurity

Last Mile セキュリティを有効にします。
デフォルト: disabled

--no-lastMileSecurity

--[no-]objectStoreV2

Object Store v2 を有効にします。
デフォルト: disabled

--no-objectStoreV2

--pathRewrite

アプリケーションの HTTP リスナーで要求されるベースパスを提供します。
形式: /​ で始まる必要があります

--pathRewrite /http://localhost:3000​。

--property

プロパティを設定します。
形式: name:value

--property testproperty:true

--propertiesFile

すべてのプロパティを選択済みファイルの値に置き換えます。
形式: 1 行以上の ​name:value​ 形式

--propertiesFile /Users/mule/Documents/properties.txt

--publicEndpoints

公開インターネット経由で到達するエンドポイントを提供します。
形式: カンマ区切りでスペースなし

--publicEndpoints my-superapp-example: /status?limit=10

--replicas

レプリカの数。​0​ より大きい必要があります。
デフォルト: 1

--replicas 2

--replicaSize

vCore のレプリカのサイズ。
デフォルト: 0.1

--replicaSize 0.5

--runtimeVersion

デプロイメント対象のランタイムバージョン。

--runtimeVersion 1.0.1

--scopeLoggingConfig

スコープログ記録を定義します。
形式: scopeName: logLevel​、カンマ区切りでスペースなし

--scopeLoggingConfig testscope1:WARN,testscope2:DEBUG

--scopeLoggingConfigFile

ファイルをアップロードしてスコープログ記録を定義します。
形式: 1 行に 1 タプル、スタイル: {scope: scopeName, logLevel: logLevelType}​ を ​{} ​()​ または ​[]​ で囲む

--scopeLoggingConfigFile /Users/mule/Documents/cert.txt

--updateStrategy

使用される戦略を更新します。
デフォルト: rolling

--updateStrategy recreate​

## [](#runtime-mgrapplicationstart)runtime-mgr:application:start \> runtime-mgr:application:start \[flags\] ``​ で指定されたアプリケーションの実行を開始します。この ID を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgrapplicationstop)runtime-mgr:application:stop \> runtime-mgr:application:stop \[flags\] ``​ で指定されたアプリケーションの実行を停止します。この ID を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgrapplicationlogs)runtime-mgr:application:logs \> runtime-mgr:application:logs \[flags\] ``​ で指定された仕様から、​``​ で指定されたアプリケーションのアプリケーションログを追跡します。 ``​ を取得するには、​`runtime-mgr application list`​ コマンドを実行します。 ``​ を取得するには、​`runtime-mgr application describe`​ コマンドを実行します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 # Runtime Manager の CLI Anypoint CLI では次の Runtime Manager 機能がサポートされます。 - [ハイブリッドアプリケーション](https://docs.mulesoft.com/jp/anypoint-cli/3.x/standalone-apps) - [ハイブリッドアプリケーションのアラート](https://docs.mulesoft.com/jp/anypoint-cli/3.x/standalone-alerts) - [ローカルサーバー](https://docs.mulesoft.com/jp/anypoint-cli/3.x/servers) - [ローカルクラスターサーバー](https://docs.mulesoft.com/jp/anypoint-cli/3.x/server-clusters) - [ローカルサーバーグループ](https://docs.mulesoft.com/jp/anypoint-cli/3.x/server-groups) # Runtime Manager の CLI Anypoint CLI では次の Runtime Manager 機能がサポートされます。 - [ハイブリッドアプリケーション](https://docs.mulesoft.com/jp/anypoint-cli/latest/standalone-apps) - [ハイブリッドアプリケーションのアラート](https://docs.mulesoft.com/jp/anypoint-cli/latest/standalone-alerts) - [ローカルサーバー](https://docs.mulesoft.com/jp/anypoint-cli/latest/servers) - [ローカルクラスターサーバー](https://docs.mulesoft.com/jp/anypoint-cli/latest/server-clusters) - [ローカルサーバーグループ](https://docs.mulesoft.com/jp/anypoint-cli/latest/server-groups) # コマンドおよびフラグの一般的な使用 Anypoint Platform CLI コマンドを使用して、スクリプト経由で商品アクションのサブセットを自動化します。Anypoint Platform CLI 4.0 以降は、バッチモードでのみ実行できます。対話型モードはサポートされなくなりました。 ## [](#構文)構文 Anypoint Platform CLI コマンドセットの構文は、次のようになります。 ```console $ anypoint-cli-v4 [command] [parameters] [flags] ``` コマンドを実行してエラーがあると、アプリケーションが終了して問題の説明が返されます。 コマンドで複数オプションのフラグを使用する場合は、フラグの前にパラメーターを置きます。 ```console anypoint-cli-v4 governance:api:validate param1 param2 --rulesets value1 --rulesets value2 --rulesets value3 ``` または、パラメーターの前に ​\`-- \`​ (2 つのダッシュの後にスペース) を使用します。 ```console anypoint-cli-v4 governance:api:validate --rulesets value1 --rulesets value2 --rulesets value3 -- param1 param2 ```
すべてのコマンドをスペースまたはコロンで区切って記述できます。たとえば、​runtime-mgr:application:list​ を ​runtime-mgr application list​ にすることもできます。
## [](#default-options)デフォルトのフラグ Anypoint Platform CLI コマンドには、次のデフォルトのフラグがあります。
フラグ 説明

--help

コマンドの使用方法を表示する

--organization

Anypoint Platform 内の組織

環境変数 ​export ANYPOINT_ORG=<name>​ を使用して、この値を渡すこともできます。

--environment

自分の Anypoint Platform 環境

環境変数 ​export ANYPOINT_ENV=<name>​ を使用して、この値を渡すこともできます。

--host

Anypoint Platform インストールのホスト
この値のデフォルトは ​anypoint.mulesoft.com​ です。

  • Anypoint Platform PCE を使用している場合、プラットフォームをホストしているアドレスを渡していることを確認します。

  • Anypoint Platform EU クラウドを使用している場合は、EU コントロールプレーン URL を渡します。

専用の環境変数 ​ANYPOINT_HOST=<name>​ を使用して、この値を渡すこともできます。例: ANYPOINT_HOST=my.anypoint.mulesoft.com​。

## [](#overrides)上書き順序 環境変数を使用して、Anypoint CLI の値を定義できます。環境変数設定と明示的なコマンドライン値を混在させた場合、上書き順序は次のようになります。 - 環境変数はログイン情報ファイルのパラメーターを上書きする。 - コマンドラインパラメーターは環境変数を上書きする。 - コマンドラインフラグを渡さない場合、デフォルトプロファイルのプロパティが使用される。 - 環境を指定しない場合、デフォルトは本番。 ## [](#session-timeout)セッションタイムアウト Anypoint Platform セッションの有効期限は、組織の設定の ​**\[Default session timeout (デフォルトセッションタイムアウト)\]**​ に基づいています。 ルート組織設定についての詳細は、​[「ルート組織設定を管理する」](https://docs.mulesoft.com/jp/access-management/organization#manage-root-organization-settings)​を参照してください。 ## [](#data-collection)匿名化された使用状況データ Anypoint CLI 環境を改善するために、匿名化された使用状況データが収集されます。​`credentials`​ ファイルで ​`collectMetrics`​ を false に設定することでオプトアウトできます。 # ネットワークプロキシでの Anypoint CLI の使用 Anypoint CLI をネットワークプロキシ経由で実行して、セキュリティレイヤーを追加できます。Anypoint CLI をプロキシサーバーで使用するには、次のセクションに示すように、​`HTTP_PROXY`​ または ​`HTTPS_PROXY`​ 環境変数を設定して、プロキシサーバーのホスト名と IP アドレスを指定します。 ## [](#認証なしのプロキシサーバーを設定する)認証なしのプロキシサーバーを設定する 認証を必要としないプロキシサーバーを設定するには、次のコマンドを使用します。 - Linux、macOS、または Unix `$ export HTTP_PROXY=http://​_proxy-server_​:80` または `$ export HTTPS_PROXY=https://​_proxy-server_​:443` - Windows `> set HTTP_PROXY=http://​_proxy-server_​:80` または `> set HTTPS_PROXY=https//​_proxy-server_​:443` ## [](#認証ありのプロキシサーバーを設定する)認証ありのプロキシサーバーを設定する 認証が必要なプロキシサーバーを設定するには、次のコマンドを使用します。 - Linux、macOS、または Unix `$ export HTTP_PROXY=http://​_username_​:_password_​@​_proxy-server_​:80` または `$ export HTTPS_PROXY=https://​_username_​:_password_​@​_proxy-server_​:443` - Windows `> set HTTP_PROXY=http://​_username_​:_password_​@​_proxy-server_​:80` または `> set HTTPS_PROXY=https://​_username_​:_password_​@​_proxy-server_​:443` # バージョン 4.x と以前のバージョンの違い Anypoint Platform CLI 4.x より前のバージョンを使用するスクリプトは、新しいバージョンの CLI ではコマンド名と構文が異なるため、Anypoint CLI 4.x コマンドは自動的に使用されません。ただし、CLI バージョン 4.x の名前とインストールパッケージは以前のバージョンとは異なるため、Anypoint CLI 4.x と以前のバージョンを同じシステムにインストールし、スクリプトで両方のバージョンを使用できます。 警告: Anypoint CLI 4.x には、以前のバージョンとの後方互換性がありません。 新しいスクリプトを記述したり既存のスクリプトを更新したりする場は、Anypoint CLI 4.x を使用して、将来のリリースでの新機能と修正を利用してください。プラグインは、Anypoint Platform CLI 4.x でのみ使用できます。 ## [](#変更)変更 Anypoint CLI 4.x には、次の変更があります。 - **CLI 名**​ 新しい CLI 名は ​`anypoint-cli-v4`​ です。 - **インストール**​ Anypoint Platform コンポーネントのコマンドグループは、必要に応じてコアインストールパッケージとは別にインストールおよびアンインストールできるプラグインとしてパッケージ化されています。 - **認証**​ - `~/.config/@mulesoft/anypoint-cli-v4-nodejs/config.json`​ にあるログイン情報ファイルを使用する代わりに、​`anypoint-cli-v4 conf`​ コマンドを使用してログイン情報を設定します。 - SSO はサポートされなくなりました。すべてのユーザーに対する多要素認証 (MFA) の有効化の一環として、Anypoint CLI を使用する方法は​[接続アプリケーション](https://docs.mulesoft.com/jp/access-management/connected-apps-overview)​経由のみです。 - **コマンド構文**​ コマンドパラメーター間の区切り文字は、コロン (:) またはスペースのいずれかです。たとえば、Exchange アセットリソースリストを取得するコマンドは、​`anypoint-cli-v4 exchange:asset:resource:list`​ または ​`anypoint-cli-v4 exchange asset resource list`​ のいずれかです。 - **コマンドとプロパティ**​ 次のコマンドとプロパティが変更されました。 - `exchange:asset:upload` ​`exchange:asset:uploadv2`​ の代わりに使用されます。 - `exchange:asset:upload --properties='{"property1":"value2", "property2": "value2"}'` ​`exchange:asset:upload properties.value1.value2`​ の代わりに使用されます。 - `cloudhub:load-balancer:allowlist:add/remove`​ 包括的な用語を使用した同様のコマンドの代わりに使用されます。 - `runtime-mgr:cloudhub-application:describe -o JSON` ​`runtime-mgr cloudhub-application describe-json`​ の代わりに使用されます。 - `runtime-mgr:pcf-application:describe -o JSON` ​`runtime-mgr pcf-application describe-json`​ の代わりに使用されます。 - `cloudhub:vpc:describe -o JSON` ​`cloudhub vpc describe-json`​ の代わりに使用されます。 - 環境およびビジネスグループのコマンドはサポートされなくなりました。 - DataGraph API ソース管理のコマンドはサポートされなくなりました。 - **対話型モード**​ 対話型モードはサポートされなくなったため、次のコマンドとフラグは使用できなくなりました。 - `use business-group`​ コマンド - `use environment`​ コマンド - `exit`​ コマンド - `-f, --fields`​ フラグ - パスワードを省略した場合にパスワードを対話的に入力する機能 \*Anypoint CLI 4.x のコマンドで複数オプションのフラグを使用する場合は、フラグの前にパラメーターを置くか、パラメーターの前に ​\`-- \`​ (2 つのダッシュの後にスペース) を使用する必要があります。 # ハイブリッドアプリケーションアラートの CLI ローカル Mule サーバーにデプロイされていて Runtime Manager で管理されるアプリケーションのアラートを制御するには、次のコマンドを使用します。
コマンド 説明

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

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

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

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

## [](#runtime-mgr-standalone-alert-describe)runtime-mgr standalone-alert describe \> runtime-mgr standalone-alert describe \[options\] このコマンドは、​`alertId`​ で渡されるアラートの情報を表示します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-standalone-alert-create)runtime-mgr standalone-alert create \> runtime-mgr standalone-alert create \[options\] このコマンドは、​`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 \> runtime-mgr standalone-alert modify \[options\] このコマンドは、​`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 \> runtime-mgr standalone-alert list \[options\] このコマンドは、現在の環境のスタンドアロン Mule のすべてのアラートをリストします。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 # ハイブリッドアプリケーションアラートの CLI ローカル Mule サーバーにデプロイされていて Runtime Manager で管理されるアプリケーションのアラートを制御するには、次のコマンドを使用します。
コマンド 説明

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

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

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

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

## [](#runtime-mgr-standalone-alert-describe)runtime-mgr:standalone-alert:describe \> runtime-mgr:standalone-alert:describe \[flags\] このコマンドは、​`alertId`​ で渡されるアラートの情報を表示します。 このコマンドには ​`--output`​ フラグを使用できます。​`--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 このコマンドでは、デフォルトのフラグ ​`--help`​ も受け入れます。 ## [](#runtime-mgr-standalone-alert-create)runtime-mgr:standalone-alert:create \> runtime-mgr:standalone-alert:create \[flags\] このコマンドは、​`name`​ で渡される ID を使用して、スタンドアロンランタイムの新しいアラートを作成します。 アラート ​`name`​ は 256 文字に制限されます。 このコマンドでは、デフォルトの ​`--help`​ フラグ以外に次のフラグも受け入れます。
フラグ 説明

--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 件のメールアドレスを指定できます。

このコマンドには複数オプションのフラグがあります。コマンドで複数オプションのフラグを使用する場合は、フラグの前にパラメーターを置くか、パラメーターの前に ​`-- `​ (2 つのダッシュの後にスペース) を使用します。
## [](#runtime-mgr-standalone-alert-modify)runtime-mgr:standalone-alert:modify \> runtime-mgr:standalone-alert:modify \[flags\] このコマンドは、​`alertId`​ で渡されるアラートを変更します。 このコマンドでは、デフォルトの ​`--help`​ フラグ以外に次のフラグも受け入れます。
フラグ 説明

--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 件のメールアドレスを指定できます。

このコマンドには複数オプションのフラグがあります。コマンドで複数オプションのフラグを使用する場合は、フラグの前にパラメーターを置くか、パラメーターの前に ​`-- `​ (2 つのダッシュの後にスペース) を使用します。
## [](#runtime-mgr-standalone-alert-list)runtime-mgr:standalone-alert:list \> runtime-mgr:standalone-alert:list \[flags\] このコマンドは、現在の環境のスタンドアロン Mule のすべてのアラートをリストします。 このコマンドには ​`--output`​ フラグを使用できます。​`--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 このコマンドでは、デフォルトのフラグ ​`--help`​ も受け入れます。 # ハイブリッドアプリケーションの CLI ローカル Mule サーバーにデプロイされていて Runtime Manager で管理されるアプリケーションには次のコマンドを使用します。 Anypoint Platform CLI で対象サーバーを認識できるように、手動で各サーバーをプラットフォームに登録する必要があります。
コマンド 説明

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

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

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

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

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

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

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

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

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

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

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

## [](#runtime-mgr-standalone-application-artifact)runtime-mgr standalone-application artifact \> runtime-mgr standalone-application artifact \[options\] このコマンドは、​`identifier`​ アプリケーションのアプリケーションアーティファクトを ​`directory`​ で渡されるディレクトリにダウンロードします。 `identifier`​ パラメーターは、アプリケーション ID または名前のいずれかになります。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-standalone-application-deploy)runtime-mgr standalone-application deploy \> runtime-mgr standalone-application deploy \[options\] このコマンドは、パス ​`zipfile`​ の ZIP ファイルとして渡されるアプリケーションを ​`targetIdentifier`​ で渡されるオンプレミスの対象にデプロイまたは再デプロイします。 `targetIdentifier`​ パラメーターは、対象 ID または名前のいずれかになります。 対象は、サーバー、サーバーグループ、クラスターのいずれかになります。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 アプリケーションを再デプロイしてログレベルを設定したり、インサイトイベント追跡を有効にしたりするには、「​[runtime-mgr standalone-application modify](#runtime-mgr-standalone-application-modify)​」を参照してください。 ## [](#runtime-mgr-standalone-application-describe-json)runtime-mgr standalone-application describe-json \> runtime-mgr standalone-application describe-json \[options\] このコマンドでは、​`identifier`​ で渡されるスタンドアロン (オンプレミス) アプリケーションの情報を未加工の JSON 応答として表示します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-standalone-application-modify)runtime-mgr standalone-application modify \> runtime-mgr standalone-application modify \[options\] このコマンドでは、パスとして ​`zipfile`​ で渡される ZIP ファイルアプリケーションを使用して、​`identifier`​ で渡されるスタンドアロン (オンプレミス) アプリケーションを変更します。 `identifier`​ パラメーターでは、アプリケーション識別子を指定します。 識別子を取得するには、「​[runtime-mgr standalone-application list](https://docs.mulesoft.com/jp/anypoint-cli/latest/standalone-apps#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 Connector の ​org.mule.extension.ftp​ など)

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

## [](#runtime-mgr-standalone-application-start)runtime-mgr standalone-application start \> runtime-mgr standalone-application start \[options\] このコマンドでは、​`identifier`​ で渡されるスタンドアロン (オンプレミス) アプリケーションを開始します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-standalone-application-delete)runtime-mgr standalone-application delete \> runtime-mgr standalone-application delete \[options\] このコマンドでは、​`identifier`​ で渡されるスタンドアロン (オンプレミス) アプリケーションを削除します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
## [](#runtime-mgr-standalone-application-describe)runtime-mgr standalone-application describe \> runtime-mgr standalone-application describe \[options\] このコマンドでは、​`identifier`​ で渡されるスタンドアロン (オンプレミス) アプリケーションの状況、作成日、最終更新日などの詳細情報を表示します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-standalone-application-list)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 \> runtime-mgr standalone-application restart \[options\] このコマンドでは、​`identifier`​ で渡されるスタンドアロン (オンプレミス) アプリケーションを再起動します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-standalone-application-stop)runtime-mgr standalone-application stop \> runtime-mgr standalone-application stop \[options\] このコマンドでは、​`identifier`​ で渡されるスタンドアロン (オンプレミス) アプリケーションを停止します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-standalone-application-copy)runtime-mgr standalone-application copy \> runtime-mgr standalone-application copy \[options\] このコマンドでは、​`source`​ で渡されるスタンドアロン (オンプレミス) アプリケーションを ​`target`​ で渡される対象およびサーバー、サーバーグループ、クラスター ID (​`targetIdentifier`​ で渡される名前) にコピーします。 `source`​ と ​`destination`​ の引数はどちらも、次のように ​`:/`​ の形式を使用して表されます。 \> 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`​ のみを受け入れます。 # ローカルクラスターサーバーの CLI
コマンド 説明

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

クラスターを削除する

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

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

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

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

クラスターを変更する

## [](#runtime-mgr-cluster-add-server)runtime-mgr cluster add server \> runtime-mgr cluster add server \[options\] このコマンドは、​`clusterId`​ のクラスターを ​`serverId`​ で渡されるサーバーに追加します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-cluster-delete)runtime-mgr cluster delete \> runtime-mgr cluster delete \[options\] このコマンドは、​`clusterId`​ で渡されるクラスターを削除します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
## [](#runtime-mgr-cluster-list)runtime-mgr cluster list \> runtime-mgr cluster list \[options\] このコマンドは、環境内のすべてのクラスターをリストします。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-cluster-remove-server)runtime-mgr cluster remove server \> runtime-mgr cluster remove server \[options\] このコマンドは、​`clusterId`​ で渡されるクラスターから ​`serverId`​ で渡されるサーバーを削除します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-cluster-create)runtime-mgr cluster create \> runtime-mgr cluster create \[options\] このコマンドは、​`name`​ で渡される ID を使用してクラスターを作成します。 このコマンドでは、デフォルトの ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ オプション以外に次のオプションも使用できます。
オプション 説明

--multicast

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

--server <id:ip>

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

## [](#runtime-mgr-cluster-describe)runtime-mgr cluster describe \> runtime-mgr cluster describe \[options\] このコマンドは、​`clusterId`​ で渡されるクラスターの情報を表示します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-cluster-modify)runtime-mgr cluster modify \> runtime-mgr cluster modify \[options\] このコマンドは、​`clusterId`​ で渡されるクラスターを変更します。 クラスターの ID を更新するには、​`--name`​ オプションを渡す必要があります。 このコマンドでは、​`--name`​ オプション以外にデフォルトの ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ オプションも使用できます。 # ローカルクラスターサーバーの CLI
コマンド 説明

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

クラスターを削除する

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

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

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

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

クラスターを変更する

## [](#runtime-mgr-cluster-add-server)runtime-mgr:cluster:add:server \> runtime-mgr:cluster:add:server \[flags\] このコマンドは、​`clusterId`​ のクラスターを ​`serverId`​ で渡されるサーバーに追加します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgr-cluster-delete)runtime-mgr:cluster:delete \> runtime-mgr:cluster:delete \[flags\] このコマンドは、​`clusterId`​ で渡されるクラスターを削除します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
## [](#runtime-mgr-cluster-list)runtime-mgr:cluster:list \> runtime-mgr:cluster:list \[flags\] このコマンドは、環境内のすべてのクラスターをリストします。 このコマンドには ​`--output`​ フラグを使用できます。​`--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 このコマンドでは、デフォルトのフラグ ​`--help`​ も受け入れます。 ## [](#runtime-mgr-cluster-remove-server)runtime-mgr:cluster:remove:server \> runtime-mgr:cluster:remove:server \[flags\] このコマンドは、​`clusterId`​ で渡されるクラスターから ​`serverId`​ で渡されるサーバーを削除します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgr-cluster-create)runtime-mgr:cluster:create \> runtime-mgr:cluster:create \[flags\] このコマンドは、​`name`​ で渡される ID を使用してクラスターを作成します。 このコマンドでは、デフォルトの ​`--help`​ フラグ以外に次のフラグも受け入れます。
フラグ 説明

--multicast

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

--server <id:ip>

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

このコマンドには複数オプションのフラグがあります。コマンドで複数オプションのフラグを使用する場合は、フラグの前にパラメーターを置くか、パラメーターの前に ​`-- `​ (2 つのダッシュの後にスペース) を使用します。
## [](#runtime-mgr-cluster-describe)runtime-mgr:cluster:describe \> runtime-mgr:cluster:describe \[flags\] このコマンドは、​`clusterId`​ で渡されるクラスターの情報を表示します。 このコマンドには ​`--output`​ フラグを使用できます。​`--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 このコマンドでは、デフォルトのフラグ ​`--help`​ も受け入れます。 ## [](#runtime-mgr-cluster-modify)runtime-mgr:cluster:modify \> runtime-mgr:cluster:modify \[flags\] このコマンドは、​`clusterId`​ で渡されるクラスターを変更します。 クラスターの ID を更新するには、​`--name`​ フラグを渡す必要があります。 このコマンドでは、​`--name`​ フラグ以外にデフォルトの ​`--help`​ フラグも使用できます。 # ローカルサーバーグループの CLI
コマンド 説明

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

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

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

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

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

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

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

## [](#runtime-mgr-servergroup-create)runtime-mgr serverGroup create \> runtime-mgr serverGroup create \[options\] \[serverIds...\] このコマンドは、後で引数として渡されるサーバー ID を使用して、​`name`​ で渡される名前でサーバーグループを作成します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-servergroup-describe)runtime-mgr serverGroup describe \> runtime-mgr serverGroup describe \[options\] このコマンドは、​`serverGroupId`​ で渡されるサーバーグループの情報を表示します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-servergroup-modify)runtime-mgr serverGroup modify \> runtime-mgr serverGroup modify \[options\] このコマンドは、​`serverGroupId`​ で渡されるサーバーグループを変更します。 クラスターの ID を更新するには、​`--name`​ オプションを渡す必要があります。 このコマンドでは、​`--name`​ オプション以外にデフォルトの ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ オプションも使用できます。 ## [](#runtime-mgr-servergroup-add-server)runtime-mgr serverGroup add server \> runtime-mgr serverGroup add server \[options\] このコマンドは、​`serverId`​ で渡されるサーバーを ​`serverGroupId`​ で渡されるサーバーグループに追加します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-servergroup-delete)runtime-mgr serverGroup delete \> runtime-mgr serverGroup delete \[options\] このコマンドは、​`serverGroupId`​ で渡されるサーバーグループを削除します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
## [](#runtime-mgr-servergroup-list)runtime-mgr serverGroup list \> runtime-mgr serverGroup list \[options\] このコマンドは、環境内のすべてのサーバーグループをリストします。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-servergroup-remove-server)runtime-mgr serverGroup remove server \> runtime-mgr serverGroup remove server \[options\] このコマンドでは、​`serverGroupId`​ で渡されるサーバーグループから ​`serverId`​ で渡されるサーバーを削除します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 # ローカルサーバーグループの CLI
コマンド 説明

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

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

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

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

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

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

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

## [](#runtime-mgr-servergroup-create)runtime-mgr:serverGroup:create \> runtime-mgr:serverGroup:create \[flags\] \[serverIds...\] このコマンドは、後で引数として渡されるサーバー ID を使用して、​`name`​ で渡される名前でサーバーグループを作成します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgr-servergroup-describe)runtime-mgr:serverGroup:describe \> runtime-mgr:serverGroup:describe \[flags\] このコマンドは、​`serverGroupId`​ で渡されるサーバーグループの情報を表示します。 このコマンドには ​`--output`​ フラグを使用できます。​`--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 このコマンドでは、デフォルトのフラグ ​`--help`​ も受け入れます。 ## [](#runtime-mgr-servergroup-modify)runtime-mgr:serverGroup:modify \> runtime-mgr:serverGroup:modify \[flags\] このコマンドは、​`serverGroupId`​ で渡されるサーバーグループを変更します。 クラスターの ID を更新するには、​`--name`​ フラグを渡す必要があります。 このコマンドでは、​`--name`​ フラグ以外にデフォルトの ​`--help`​ フラグも使用できます。 ## [](#runtime-mgr-servergroup-add-server)runtime-mgr:serverGroup:add:server \> runtime-mgr:serverGroup:add:server \[flags\] このコマンドは、​`serverId`​ で渡されるサーバーを ​`serverGroupId`​ で渡されるサーバーグループに追加します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgr-servergroup-delete)runtime-mgr:serverGroup:delete \> runtime-mgr:serverGroup:delete \[flags\] このコマンドは、​`serverGroupId`​ で渡されるサーバーグループを削除します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
## [](#runtime-mgr-servergroup-list)runtime-mgr:serverGroup:list \> runtime-mgr:serverGroup:list \[flags\] このコマンドは、環境内のすべてのサーバーグループをリストします。 このコマンドには ​`--output`​ フラグを使用できます。​`--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 このコマンドでは、デフォルトのフラグ ​`--help`​ も受け入れます。 ## [](#runtime-mgr-servergroup-remove-server)runtime-mgr:serverGroup:remove:server \> runtime-mgr:serverGroup:remove:server \[flags\] このコマンドでは、​`serverGroupId`​ で渡されるサーバーグループから ​`serverId`​ で渡されるサーバーを削除します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 # ローカルサーバーの CLI
コマンド 説明

サーバーの情報を表示する

サーバーを変更する

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

サーバーを削除する

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

## [](#runtime-mgr-server-describe)runtime-mgr server describe \> runtime-mgr server describe \[options\] このコマンドは、​`serverId`​ で渡されるサーバーの情報を表示します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-server-modify)runtime-mgr server modify \> runtime-mgr server modify \[options\] このコマンドは、​`serverId`​ で渡されるサーバーを変更します。 クラスターの ID を更新するには、​`--name`​ オプションを渡す必要があります。 このコマンドでは、​`--name`​ オプション以外にデフォルトの ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ オプションも使用できます。 ## [](#runtime-mgr-server-token)runtime-mgr server token \> runtime-mgr server token \[options\] このコマンドは、サーバー登録トークンを取得します。新しいサーバーを登録するには、このトークンを使用する必要があります。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#runtime-mgr-server-delete)runtime-mgr server delete \> runtime-mgr server delete \[options\] このコマンドは、​`serverId`​ で渡されるサーバーを削除します。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
## [](#runtime-mgr-server-list)runtime-mgr server list \> runtime-mgr server list \[options\] このサーバーは、環境内のすべてのサーバーをリストします。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 # ローカルサーバーの CLI
コマンド 説明

サーバーの情報を表示する

サーバーを変更する

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

サーバーを削除する

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

## [](#runtime-mgr-server-describe)runtime-mgr:server:describe \> runtime-mgr:server:describe \[flags\] このコマンドは、​`serverId`​ で渡されるサーバーの情報を表示します。 このコマンドには ​`--output`​ フラグを使用できます。​`--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgr-server-modify)runtime-mgr:server:modify \> runtime-mgr:server:modify \[flags\] このコマンドは、​`serverId`​ で渡されるサーバーを変更します。 クラスターの ID を更新するには、​`--name`​ フラグを渡す必要があります。 このコマンドでは、​`--name`​ フラグ以外にデフォルトの ​`--help`​ フラグも使用できます。 ## [](#runtime-mgr-server-token)runtime-mgr:server:token \> runtime-mgr:server:token \[flags\] このコマンドは、サーバー登録トークンを取得します。新しいサーバーを登録するには、このトークンを使用する必要があります。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgr-server-delete)runtime-mgr:server:delete \> runtime-mgr:server:delete \[flags\] このコマンドは、​`serverId`​ で渡されるサーバーを削除します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
## [](#runtime-mgr-server-list)runtime-mgr:server:list \> runtime-mgr:server:list \[flags\] このサーバーは、環境内のすべてのサーバーをリストします。 このコマンドには ​`--output`​ フラグを使用できます。​`--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 このコマンドでは、デフォルトのフラグ ​`--help`​ も受け入れます。 # ローカルにデプロイされていて Runtime Manager で管理されるアプリケーション
Anypoint Platform CLI で対象サーバーを認識できるように、手動で各サーバーをプラットフォームに登録する必要があります。
コマンド 説明

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

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

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

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

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

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

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

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

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

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

## [](#runtime-mgr-standalone-application-artifact)runtime-mgr:standalone-application:artifact \> runtime-mgr:standalone-application:artifact \[flags\] このコマンドは、​`identifier`​ アプリケーションのアプリケーションアーティファクトを ​`directory`​ で渡されるディレクトリにダウンロードします。 `identifier`​ フラグは、アプリケーション ID または名前のいずれかになります。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgr-standalone-application-deploy)runtime-mgr:standalone-application:deploy \> runtime-mgr:standalone-application:deploy \[flags\] このコマンドは、パス ​`zipfile`​ の ZIP ファイルとして渡されるアプリケーションを ​`targetIdentifier`​ で渡されるオンプレミスの対象にデプロイまたは再デプロイします。 `targetIdentifier`​ フラグは、対象 ID または名前のいずれかになります。 対象は、サーバー、サーバーグループ、クラスターのいずれかになります。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 アプリケーションを再デプロイしてログレベルを設定したり、インサイトイベント追跡を有効にしたりするには、「​[runtime-mgr:standalone-application:modify](#runtime-mgr-standalone-application-modify)​」を参照してください。 ## [](#runtime-mgr-standalone-application-modify)runtime-mgr:standalone-application:modify \> runtime-mgr:standalone-application:modify \[flags\] このコマンドでは、パスとして ​`zipfile`​ で渡される ZIP ファイルアプリケーションを使用して、​`identifier`​ で渡されるスタンドアロン (オンプレミス) アプリケーションを変更します。 `identifier`​ オプションでは、アプリケーション識別子を指定します。 識別子を取得するには、「​[runtime-mgr:standalone-application:list](#runtime-mgr-standalone-application-list)​」を参照してください。 このコマンドでは、デフォルトの ​`--help`​ フラグ以外に次のフラグも受け入れます。
フラグ 説明

--insight

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

--log [level:scope]

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

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

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

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

## [](#runtime-mgr-standalone-application-start)runtime-mgr:standalone-application:start \> runtime-mgr:standalone-application:start \[flags\] このコマンドでは、​`identifier`​ で渡されるスタンドアロン (オンプレミス) アプリケーションを開始します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgr-standalone-application-delete)runtime-mgr:standalone-application:delete \> runtime-mgr:standalone-application:delete \[flags\] このコマンドでは、​`identifier`​ で渡されるスタンドアロン (オンプレミス) アプリケーションを削除します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。
## [](#runtime-mgr-standalone-application-describe)runtime-mgr:standalone-application:describe \> runtime-mgr:standalone-application:describe \[flags\] このコマンドでは、​`identifier`​ で渡されるスタンドアロン (オンプレミス) アプリケーションの状況、作成日、最終更新日などの詳細情報を表示します。 フラグ ​`-o json`​ を使用して、​``​ で指定するアプリケーションの未加工の JSON 応答を取得します。 このコマンドには ​`--output`​ フラグを使用できます。​`--output`​ フラグを使用して、応答形式を指定します。サポートされている値は、​`table`​ (デフォルト) および ​`json`​ です。 このコマンドでは、デフォルトのフラグ ​`--help`​ も受け入れます。 ## [](#runtime-mgr-standalone-application-list)runtime-mgr:standalone-application:list \> runtime-mgr:standalone-application:list \[flags\] このコマンドでは、すべてのスタンドアロン (オンプレミス) アプリケーションをリストします。 このコマンドでは、デフォルトの ​`--help`​ フラグ以外に次のフラグも受け入れます。
フラグ 説明

--limit <num>

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

--offset <num>​

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

--output​ <value>

応答形式を指定する。

## [](#runtime-mgr-standalone-application-restart)runtime-mgr:standalone-application:restart \> runtime-mgr:standalone-application:restart \[flags\] このコマンドでは、​`identifier`​ で渡されるスタンドアロン (オンプレミス) アプリケーションを再起動します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgr-standalone-application-stop)runtime-mgr:standalone-application:stop \> runtime-mgr:standalone-application:stop \[flags\] このコマンドでは、​`identifier`​ で渡されるスタンドアロン (オンプレミス) アプリケーションを停止します。 このコマンドでは、デフォルトのフラグ ​`--help`​ のみを受け入れます。 ## [](#runtime-mgr-standalone-application-copy)runtime-mgr:standalone-application:copy \> runtime-mgr:standalone-application:copy \[flags\] このコマンドでは、​`source`​ で渡されるスタンドアロン (オンプレミス) アプリケーションを ​`target`​ で渡される対象およびサーバー、サーバーグループ、クラスター ID (​`targetIdentifier`​ で渡される名前) にコピーします。 `source`​ と ​`destination`​ の引数はどちらも、次のように ​`:/`​ の形式を使用して表されます。 \> 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`​ のみを受け入れます。 # 環境およびビジネスグループの CLI
コマンド 説明

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

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

## [](#use-environment)use environment このコマンドは、対話型モードでのみ使用できます。 \> use environment \[options\] このコマンドは、​``​ で指定される環境をアクティブにします。 このコマンドはデフォルトのオプション ​`--help`​、​`-f`​/​`--fields`​、​`-o`​/​`--output`​ のみを受け入れます。 ## [](#use-business-group)use business-group このコマンドは、対話型モードでのみ使用できます。 \> use business-group \[options\] このコマンドは、​``​ で指定されるビジネスグループをアクティブにします。

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

> use business-group "QA Organization"