Flex Gateway新着情報
Governance新着情報
Monitoring API Managerコマンド | 説明 |
---|---|
Exchange Experience API を使用して Exchange アセットをアップロードする |
|
既存の Exchange アセットの変更可能なデータを変更する |
|
Exchange アセットを変更する |
|
Exchange アセットをダウンロードする |
|
すべてのアセットをリストする |
|
Exchange のアセットの説明ページをダウンロードする |
|
Exchange のアセットの説明ページを変更する |
|
Exchange のアセットの説明ページをアップロードする |
|
Exchange のアセットの説明ページを更新する |
|
Exchange のアセットの説明ページを削除する |
|
特定のアセットのすべてのページをリストする |
|
Exchange アセットをコピーする |
|
Exchange のアセットを削除する |
|
アセットを非推奨にする |
|
アセットの非推奨を解除する |
|
特定のアセットの情報を表示する |
|
アセットポータルにリソースをアップロードする |
|
アセットポータルでパブリッシュ済みのリソースをリストする |
|
アセットポータルからリソースをダウンロードする |
|
アセットポータルからリソースを削除する |
|
既存アセットの状況を変更する |
Exchange コマンドは現在、GovCloud では使用できません。 |
> exchange:asset:upload [flags] <assetIdentifier>
このコマンドでは、<assetIdentifier>
で渡される 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 がデフォルトに設定されます。
フラグ | 説明 |
---|---|
|
アセット名 (pom ファイルが指定されていない場合に必要) 次に例を示します。
|
|
アセットの説明 |
|
アセットプロパティ 次に例を示します。
|
|
アセットファイル ( 複数のファイルを送信するには通常、同じフラグを複数回使用します。
ルールセットを含むルールセットドキュメントをアップロードする場合は例外です。分類子とパッケージ化オプションの両方のセットを 1 つの
例: POM ファイルと RAML 仕様をアップロードする:
ルールセットとそのドキュメントをアップロードする:
|
|
アセットタイプ ファイルが指定されていない場合に必要です。 サポートされる値:
アップロードされると、タイプはファイルの分類子から推定されます。 アセットタイプに応じて、次のような分類子の値があります。
|
|
カテゴリ (値は JSON 形式の文字列である必要があります) '{"key": "value"}' 次に例を示します。 '{"Department": "IT"}' |
|
項目 (値は JSON 形式の文字列である必要があります) '{"key": "value"}' 次に例を示します。 '{"releaseDate": "2020-01-01T20:00:00.000Z"}' |
|
キーワード (カンマ区切り) 次に例を示します。
|
|
タグ (カンマ区切り) 次に例を示します。
|
|
アセットの連動関係 (カンマ区切り) 次に例を示します。
|
|
アセットの状況 サポートされる値:
デフォルト値:
|
> exchange:asset:mutableDataUpload [flags] <assetIdentifier>
このコマンドでは、タグ、カテゴリ、項目、ドキュメントを含む作成済みの変更可能なデータを変更します。
assetIdentifier 引数には次の形式を使用します。
[<groupID>]/<assetID>/<version>
group_id が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。
フラグ | 説明 | 例 |
---|---|---|
|
ドキュメントファイル。(「zip」ファイルパスを指定する必要があります。例: "--docs /…/file-path/docs.zip") |
|
|
カテゴリ |
|
|
項目 |
|
|
タグ (カンマ区切り) |
|
> exchange:asset:updateStatus [flags] <assetIdentifier>
このコマンドは、作成済みのアセットの状況を変更します。
assetIdentifier 引数には次の形式を使用します。
[<groupID>]/<assetID>/<version>
group_id が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。
フラグ | 説明 | 例 |
---|---|---|
|
アセットの状況 サポートされる値:
|
|
有効な移行:
移行元 | 移行先 |
---|---|
|
|
|
|
|
|
published
状態は stable
状態に対応することに注意してください
> exchange:asset:modify [flags] <assetIdentifier>
このコマンドは、<assetIdentifier>
で識別される Exchange アセットを変更します。
引数 assetIdentifier
は、([group_id]/)<asset_id>/<version>
の形式にする必要があります。
group_id
が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。
このコマンドでは、デフォルトの --help
フラグ以外に次のフラグも受け入れます。
フラグ | 説明 | 例 |
---|---|---|
|
新しいアセット名 .2+<.< |
|
|
アセットのカンマ区切りタグ |
|
> exchange:asset:download [flags] <assetIdentifier> <directory>
このコマンドは、<assetIdentifier>
で識別される Exchange アセットを <directory>
で渡されるディレクトリにダウンロードします。
引数 assetIdentifier
は、([group_id]/)<asset_id>/<version>
の形式にする必要があります。
group_id
が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。
このコマンドでは、デフォルトのフラグ --help
のみを受け入れます。
> exchange:asset:list [flags] [searchText]
このコマンドは、Exchange のすべてのアセットをリストします。
searchText でキーワードを指定して、それらの特定のキーワードが含まれる API のみが結果に表示されるように制限できます。 |
このコマンドでは、デフォルトの --help
フラグ以外に次のフラグも受け入れます。
フラグ | 説明 | 例 |
---|---|---|
|
取得する結果の数 |
|
|
渡された API の数値をオフセットする |
|
|
組織 ID で絞り込む |
|
|
応答形式を指定する。 |
|
> exchange:asset:page:download [flags] <assetIdentifier> <directory> [pageName]
このコマンドは、<assetIdentifier>
で識別される Exchange アセットの <pageName>
で指定される説明ページを <directory>
で渡されるディレクトリにダウンロードします。
[pageName] が指定されていない場合、このコマンドはすべてのページをダウンロードします。
このコマンドでは、パブリッシュ済みページのみがサポートされています。 |
引数 assetIdentifier
は、([group_id]/)<asset_id>/<version>
の形式にする必要があります。
group_id
が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。
説明ページは、マークダウン形式でダウンロードされます。name
が指定されていない場合、すべてのページがダウンロードされます。
このコマンドでは、デフォルトのフラグ --help
のみを受け入れます。
> exchange:asset:page:modify [flags] <assetIdentifier> <pageName>
このコマンドは、<assetIdentifier>
で識別される Exchange アセットの <pageName>
で指定される説明ページを変更します。
このコマンドでは、パブリッシュ済みページのみがサポートされています。 |
引数 assetIdentifier
は、([group_id]/)<asset_id>/<version>
の形式にする必要があります。
group_id
が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。
このコマンドでは、デフォルトの --help
フラグ外に、新しいアセットページ名を設定する --name
フラグも使用できます。
> exchange:asset:page:upload [flags] <assetIdentifier> <pageName> <mdPath>
このコマンドは、<pageName>
で指定される名前を使用して、アセットの説明ページを <mdPath>
で渡されるパスから <assetIdentifier>
で識別される Exchange アセットにアップロードします。
ページの名前を「home」にすると、アップロードされたページが Exchange アセットのメイン説明ページになります。
このコマンドでは、操作の一環としてすべてのアクティブなドラフトをパブリッシュします。 |
引数 assetIdentifier
は、[group_id]/<asset_id>/<version>
の形式にする必要があります。
group_id
が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。
このコマンドでは、デフォルトのフラグ --help
のみを受け入れます。
> exchange:asset:page:update [flags] <assetIdentifier> <pageName> <mdPath>
このコマンドでは、<pageName>
で指定される名前を使用して、アセットの説明ページのコンテンツを <mdPath>
で渡されるパスから <assetIdentifier>
で識別される Exchange アセットに更新します。
ページの名前を「home」にすると、更新されたページが Exchange アセットのメイン説明ページになります。
このコマンドでは、操作の一環としてすべてのアクティブなドラフトをパブリッシュします。 |
引数 assetIdentifier
は、[group_id]/<asset_id>/<version>
の形式にする必要があります。
group_id
が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。
このコマンドでは、デフォルトのフラグ --help
のみを受け入れます。
> exchange:asset:page:delete [flags] <assetIdentifier> <pageName>
このコマンドは、<assetIdentifier>
で識別されるアセットの <pageName>
で指定される説明ページを削除します。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。 |
このコマンドでは、パブリッシュ済みページのみがサポートされています。 |
引数 assetIdentifier
は、([group_id]/)<asset_id>/<version>
の形式にする必要があります。
group_id
が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。
このコマンドでは、デフォルトのフラグ --help
のみを受け入れます。
> exchange:asset:page:list <assetIdentifier>
このコマンドは、<assetIdentifier>
で渡されるアセットのすべてのページをリストします。
引数 assetIdentifier
は、([group_id]/)<asset_id>/<version>
の形式にする必要があります。
group_id
が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。
このコマンドでは、パブリッシュ済みページのみがサポートされています。 |
このコマンドには --output
フラグを使用できます。--output
フラグを使用して、応答形式を指定します。サポートされている値は、table
(デフォルト) および json
です。
このコマンドでは、デフォルトのフラグ --help
も受け入れます。
> exchange:asset:copy [flags] <source> <target>
このコマンドは、<source>
から <target>
に Exchange アセットをコピーします。
引数 <source>
および <target>
は、([group_id]/)<asset_id>/<version>
の形式にする必要があります。
group_id
が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。
このコマンドはデフォルトのフラグ --help
と、次のフラグを受け入れます。
フラグ | 説明 | 例 |
---|---|---|
|
アセットのコピー先となる組織 ID |
|
> exchange:asset:delete [flags] <assetIdentifier>
このコマンドは、<assetIdentifier>
で渡される Exchange アセットを削除します。
このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。 |
引数 assetIdentifier
は、([group_id]/)<asset_id>/<version>
の形式にする必要があります。
group_id
が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。
このコマンドでは、デフォルトのフラグ --help
のみを受け入れます。
> exchange:asset:deprecate <assetIdentifier>
このコマンドは、<assetIdentifier>
で渡されるアセットを非推奨にします。
引数 assetIdentifier
は、([group_id]/)<asset_id>/<version>
の形式にする必要があります。
group_id
が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。
このコマンドでは、デフォルトのフラグ --help
のみを受け入れます。
> exchange:asset:undeprecate <assetIdentifier>
このコマンドは、<assetIdentifier>
で渡されるアセットの非推奨を解除します。
引数 assetIdentifier
は、([group_id]/)<asset_id>/<version>
の形式にする必要があります。
group_id
が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。
このコマンドでは、デフォルトのフラグ --help
のみを受け入れます。
> exchange:asset:describe <assetIdentifier>
このコマンドは、<assetIdentifier>
で渡されるアセットの情報を表示します。
引数 assetIdentifier
は、([group_id]/)<asset_id>/<version>
の形式にする必要があります。
group_id
が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。
このコマンドには --output
フラグを使用できます。--output
フラグを使用して、応答形式を指定します。サポートされている値は、table
(デフォルト) および json
です。
このコマンドでは、デフォルトのフラグ --help
も受け入れます。
> exchange:asset:resource:upload [flags] <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
のみを受け入れます。
> exchange:asset:resource:list [flags] <assetIdentifier>
このコマンドでは、<assetIdentifier>
で指定されたアセットのアセットポータルのリソースをリストします。
引数 assetIdentifier
は、[group_id]/<asset_id>/<version>
の形式にする必要があります。
group_id
が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。
このコマンドでは、デフォルトでパブリッシュ済みのリソースをリストします。--draft フラグを使用して、アセットポータルからドラフトリソースをリストできます。
|
このコマンドは、アセットポータル内のパブリッシュされていないリソースをリストする --draft
フラグを受け入れます。
このコマンドには --output
フラグを使用できます。--output
フラグを使用して、応答形式を指定します。サポートされている値は、table
(デフォルト) および json
です。
このコマンドでは、デフォルトのフラグ --help
も受け入れます。
> exchange:asset:resource:download [flags] <assetIdentifier> <resourcePath> <filePath>
このコマンドでは、<resourcePath>
で指定されたパブリッシュ済みリソースを <assetIdentifier>
で指定されたアセットのアセットポータルから <filePath>
で指定されたファイルにダウンロードします。
引数 assetIdentifier
は、[group_id]/<asset_id>/<version>
の形式にする必要があります。
group_id
が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。
引数 <resourcePath>
はパブリッシュ済みリソースである必要があります。
すべてのパブリッシュ済みリソースは asset resource list コマンドを使用してリストできます。
このコマンドでは、パブリッシュ済みリソースのみがサポートされています。 |
このコマンドでは、デフォルトのフラグ --help
のみを受け入れます。
> exchange:asset:resource:delete [flags] <assetIdentifier> <resourcePath>
このコマンドでは、resourcePath
が削除されている新しいポータルをパブリッシュすることで、<resourcePath>
で指定されたリソースを <assetIdentifier>
で指定されたアセットのアセットポータルから削除します。
引数 <assetIdentifier>
は、[group_id]/<asset_id>/<version>
の形式にする必要があります。
group_id
が指定されていない場合、現在選択されている組織 ID がデフォルトに設定されます。
引数 <resourcePath>
はパブリッシュ済みリソースである必要があります。
すべてのパブリッシュ済みリソースは asset resource list コマンドを使用してリストできます。
このコマンドでは、操作の一環としてすべてのアクティブなドラフトをパブリッシュします。 |
このコマンドでは、デフォルトのフラグ --help
のみを受け入れます。