API Governance の CLI コマンド

Anypoint CLI コマンドを使用して、API Governance プロセスを自動化し、カスタムルールセットを操作できます。

コマンド 説明

カスタムルールセットアセットをそのドキュメントと共に Exchange にアップロードする (アセットをパブリッシュする)

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

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

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

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

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

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

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

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

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

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

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

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

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

Anypoint Platform CLI をインストールする

API Governance CLI コマンドを使用する予定がある場合は、コマンドを実行する場所に Anypoint Platform CLI をインストールします。Anypoint CLI のインストールには、API Governance プラグインが含まれています。前提条件となるソフトウェア要件を含むインストール手順についての詳細は、Anypoint CLI 4.x のインストールを参照してください。

Anypoint CLI ガバナンスコマンドの権限

Anypoint Platform の機能にアクセスする Anypoint CLI コマンドを正常に実行するには、適切な権限が必要です。

governance​ コマンドには次の権限が必要です。

  • なし:

    Anypoint Platform にアクセスせずにローカルで実行されるコマンド (​ruleset validate​、​ruleset document​、​api validate​ など)

  • Governance Administrator (ガバナンス管理者):

    API Governance エンティティを更新するコマンド (​profile create​、​profile update​、​profile delete​ など)

  • Governance Viewer (ガバナンス閲覧者):

    API Governance 情報のみをリストするコマンド (​api inspect​、​profile list​ など)

ルールセット開発 CLI

カスタムルールセットの作成には、オープンソース CLI、​ruleset-development-cli​ を使用することもできます。​「ルールセット開発 CLI を使用してルールセットを作成する」​を参照してください。