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

  3. Exchange アセット

Exchange アセットの CLI

コマンド 説明

exchange asset upload

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

exchange asset uploadv2

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

exchange asset mutableDataUpload

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

exchange asset updateStatus

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

exchange asset modify

Exchange アセットを変更する

exchange asset download

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

exchange asset list

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

exchange asset page download

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

exchange asset page modify

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

exchange asset page upload

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

exchange asset page update

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

exchange asset page delete

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

exchange asset page list

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

exchange asset copy

Exchange アセットをコピーする

exchange asset delete

Exchange のアセットを削除する

exchange asset deprecate

アセットを非推奨にする

exchange asset undeprecate

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

exchange asset describe

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

exchange asset resource upload

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

exchange asset resource list

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

exchange asset resource download

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

exchange asset resource delete

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

exchange asset upload

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

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

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

オプション 説明 例

--apiVersion

アセット API バージョン

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

exchange asset upload --mainFile 'api.yml'

--name

アセット名

--mainFile

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

--classifier

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

exchange asset uploadv2

> exchange asset uploadv2 [properties] <assetIdentifier>

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

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

([​groupID​]/)​assetID​/version

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

オプション 説明 例

--name

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

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

--description

アセットの説明

--properties

アセットプロパティ

次に例を示します。

  • properties.mainFile main.yaml​

  • properties.apiVersion v1​

  • properties.assetLink http://api.com​

--files

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

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

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

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

--type

アセットタイプ

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

サポートされる値:

  • rest-api​

  • soap-api​

  • http-api​

  • raml-fragment​

  • custom​

  • connector​

  • template​

  • example​

  • policy​

  • app​

  • extension​

  • external-library​

  • 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 [properties] <assetIdentifier>

このコマンドでは、タグ、カテゴリ、項目、ドキュメントを含む作成済みの変更可能なデータを変更します。

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

[​<groupID>​]/​<assetID>​/<version>

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 [properties] <assetIdentifier>

このコマンドは、作成済みのアセットの状況を変更します。

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

[​<groupID>​]/​<assetID>​/<version>

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

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

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

オプション 説明 例

--name

新しいアセット名

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

--tags

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

exchange asset download

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

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

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

exchange asset list

> exchange asset list [options] [searchText]

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

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

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

オプション 説明 例

--limit

取得する結果の数

exchange asset list --limit 2

--offset

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

exchange asset list --offset 3

--organizationId

組織 ID で絞り込む

exchange asset list --organizationId a12b3c45-de6f-789g-hi01-j2klm3nop4q5

exchange asset page download

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

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

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

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

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

exchange asset page modify

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

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

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

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

exchange asset page upload

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

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

このコマンドでは、操作の一環としてすべてのアクティブなドラフトをパブリッシュします。

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

exchange asset page update

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

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

このコマンドでは、操作の一環としてすべてのアクティブなドラフトをパブリッシュします。

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

exchange asset page delete

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

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

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

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

exchange asset page list

> exchange asset page list <assetIdentifier>

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

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

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

exchange asset copy

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

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

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

オプション 説明 例

--targetOrganizationId

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

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

exchange asset delete

> exchange asset delete [options] <assetIdentifier>

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

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

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

exchange asset deprecate

> exchange asset deprecate <assetIdentifier>

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

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

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

exchange asset undeprecate

> exchange asset undeprecate <assetIdentifier>

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

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

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

exchange asset describe

> exchange asset describe <assetIdentifier>

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

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

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

exchange asset resource upload

> exchange asset resource upload [options] <assetIdentifier> <filepath>

このコマンドでは、​<filepath>​ で指定されたリソースを ​<assetIdentifier>​ で説明されるアセットポータルのページにアップロードします。

このコマンドは、​<assetIdentifier>​ アセットの任意のページに使用できます。

<filepath>​ でサポートされるファイルの拡張子は、​jpeg​、​jpg​、​jpe​、​gif​、​bmp​、​png​、​webp​、​ico​、​svg​、​tiff​、​tif​。

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

成功した出力コマンドはマークダウンコードスニペットになります。

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

exchange asset resource list

> exchange asset resource list [options] <assetIdentifier>

このコマンドでは、​<assetIdentifier>​ で指定されたアセットのアセットポータルのリソースをリストします。

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

このコマンドでは、デフォルトでパブリッシュ済みのリソースをリストします。
--draft​ オプションを使用して、アセットポータルからドラフトリソースをリストできます。

このコマンドでは、デフォルトの ​--help​、​-f​/​--fields​、​-o​/​--output​ オプション以外に、アセットポータルでパブリッシュされていないリソースをリストするために ​--draft​ オプションも使用できます。

exchange asset resource download

> exchange asset resource download [options] <assetIdentifier> <resourcePath> <filePath>

このコマンドでは、​<resourcePath>​ で指定されたパブリッシュ済みリソースを ​<assetIdentifier>​ で指定されたアセットのアセットポータルから ​<filePath>​ で指定されたファイルにダウンロードします。

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

引数 ​<resourcePath>​ はパブリッシュ済みリソースである必要があります。
すべてのパブリッシュ済みリソースは ​asset resource list​ コマンドを使用してリストできます。

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

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

exchange asset resource delete

> exchange asset resource delete [options] <assetIdentifier> <resourcePath>

このコマンドでは、​resourcePath​ が削除されている新しいポータルをパブリッシュすることで、​<resourcePath>​ で指定されたリソースを ​<assetIdentifier>​ で指定されたアセットのアセットポータルから削除します。

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

引数 ​<resourcePath>​ はパブリッシュ済みリソースである必要があります。
すべてのパブリッシュ済みリソースは ​asset resource list​ コマンドを使用してリストできます。

このコマンドでは、操作の一環としてすべてのアクティブなドラフトをパブリッシュします。

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