1. Homepage
  2. Anypoint CLI (3.x)

  3. API Manager

API Manager の CLI

コマンド 説明

api-mgr alert add

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

api-mgr alert list

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

api-mgr api change-specification

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

api-mgr api classify

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

api-mgr api delete

API を削除する

api-mgr api deploy

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

api-mgr api deprecate

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

api-mgr api describe

API の詳細を表示する

api-mgr api download-proxy

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

api-mgr api edit

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

api-mgr api list

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

api-mgr api manage

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

api-mgr api promote

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

api-mgr api redeploy

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

api-mgr api undeprecate

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

api-mgr contract delete

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

api-mgr contract list

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

api-mgr policy apply

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

api-mgr policy describe

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

api-mgr policy disable

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

api-mgr policy edit

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

api-mgr policy enable

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

api-mgr policy list

ポリシーをリストする

api-mgr policy remove

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

api-mgr tier add

SLA 層を作成する

api-mgr tier copy

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

api-mgr tier delete

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

api-mgr tier list

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

api-mgr alert add

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

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

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

オプション 説明

enabled

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

severity <val>

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

type <val>

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

operator <val>

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

threshold <num>

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

periods <num>

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

duration <num>

条件が発生する期間。

durationUnit <val>

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

recipient [username]

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

email [emailAddress]

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

responseTime [num]

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

responseCode [code]

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

policyId [num]

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

api-mgr alert list

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

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

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

オプション 説明 例

--offset

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

api-mgr alert list --offset 3

--sort

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

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

api-mgr api change-specification

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

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

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

api-mgr api classify

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

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

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

api-mgr api delete

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

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

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

api-mgr api deploy

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

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

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

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

オプション 説明 例

target <id>

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

api-mgr api deploy --target 1598794 643404​

applicationName <name>

アプリケーション名

api-mgr api deploy --applicationName myMuleApp 643404​

environmentName <name>

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

api-mgr api deploy --environmentName TestEnv 643404​

gatewayVersion <version>

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

api-mgr api deploy --gatewayVersion: 9.9.9.9 643404​

overwrite

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

api-mgr api deploy --overwrite: true 643404​

api-mgr api deprecate

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

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

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

api-mgr api describe

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

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

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

api-mgr api download-proxy

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

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

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

api-mgr api edit

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

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

オプション 説明

-p, --withProxy

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

-r, --referencesUserDomain

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

-m, --muleVersion4OrAbove

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

--deploymentType <value>

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

--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 [options]

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

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

オプション 説明

--assetId <value>​

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

--apiVersion <value>​

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

--instanceLabel <value>

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

--limit <num>​

取得する結果の数。

--offset

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

--sort

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

api-mgr api manage

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

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

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

オプション 説明

--type <value>

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

-p, --withProxy

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

-r, --referencesUserDomain

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

-m, --muleVersion4OrAbove

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

--deploymentType <value>

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

--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 [options] <apiInstanceId> <sourceEnvId>

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

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

オプション 説明

-a, --copyAlerts

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

-p, --copyPolicies

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

-t, --copyTiers

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

api-mgr api redeploy

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

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

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

オプション 説明

--target <id>

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

--applicationName <name>

アプリケーション名。

--environmentName <name>

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

--gatewayVersion <version>

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

--overwrite

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

api-mgr api undeprecate

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

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

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

api-mgr contract delete

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

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

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

api-mgr contract list

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

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

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

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

オプション 説明 例

--limit

取得する結果の数

exchange asset list --limit 2

--offset

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

api-mgr contract list --offset 3 643404

--sort

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

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

api-mgr policy apply

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

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

オプション 説明

--policyVersion <value>

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

--groupId <value>

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

-c, --config [configJSON]

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

--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 [options] <policyId>

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

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

オプション 説明

--policyVersion <value>

Mule4 ポリシーバージョン。

--groupId <value>

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

api-mgr policy disable

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

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

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

api-mgr policy edit

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

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

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

オプション 説明

-c, --config [configJSON​]

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

-p, --pointcut [dataJSON]

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

api-mgr policy enable

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

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

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

api-mgr policy list

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

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

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

api-mgr policy remove

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

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

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

api-mgr tier add

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

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

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

オプション 説明

-a, --autoApprove

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

--name <value>

層の名前

--description <value>

層の情報

-l, --limit <value>

--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 [options] <sourceAPIInstanceId> <targetAPIInstanceId>

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

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

api-mgr tier delete

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

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

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

api-mgr tier list

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

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

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

オプション 説明

例

--limit

取得する結果の数

api-mgr tier list --limit 2

--offset

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

api-mgr tier list --offset 3

--sort

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

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