API Manager の CLI

--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

--limit <value>

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

--offset <value>

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

--output <value>

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

--sort

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

--gatewayVersion

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

--output <value>

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

--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​

-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。

--apiVersion <value>​

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

--assetId <value>​

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

--instanceLabel <value>

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

--limit <num>​

取得する結果の数

--offset <value>

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

--sort

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

-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。

-a, --copyAlerts

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

-p, --copyPolicies

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

-t, --copyTiers

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

-providerId

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

--applicationName <name>

アプリケーション名

--environmentName <name>

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

--gatewayVersion <version>

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

--overwrite

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

--target <id>

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

--limit <value>

取得する結果の数

--limit 2

--offset <value>

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

--offset 3

--output <value>

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

--output json

--sort <value>

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

--sort id

-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 ポリシーバージョン。

--groupId <value>

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

--policyVersion <value>

Mule 4 ポリシーバージョン

--output <value>

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

-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*"}]'

-a, --autoApprove

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

--name <value>

層の名前。

--description <value>

層の情報。

-l, --limit <value>

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

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

--limit

取得する結果の数

--limit 2

--offset

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

--offset 3

--output <value>

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

--output json

--sort

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

--sort "Latest Version"