コマンド・ライン・ツールの概要

IBM® API Connect デベロッパーズ・ツールキット には、クラウド管理および API 開発と管理のためのコマンドが用意されています。

コマンド構文

一般に、コマンドの構文は次のようになります。
apic command:sub-command [argument] [options]
ここで
  • command はコマンドで、通常は、実行対象のもの (例えば、製品、アプリケーション、API、カタログなど) です。
  • sub-command は、実行するアクションです。
  • argument は引数 (指定される場合) です (例えば catalog)。
  • optionsは任意の数のコマンド・ライン・オプションで、その形式は --option [value] です。 オプションには、2 つのダッシュの代わりに単一ダッシュを使用する簡易形式もあります。
例えば、apic apps:publish --server mgmnthost.com などです。
一部のコマンドでは、コマンドまたはサブコマンドの部分が任意指定です。 例:
  • apic products:publish は apic publish と同等です。
  • apic products:list は apic products と同等です。
create コマンドの構文は、以下のように多少異なります。
apic create:type [options]
コマンド・ヘルプを表示するには、-h オプションまたは --help オプションを使用します。
注: CLI ヘルプ・テキストおよびその他のコマンド応答テキストが表示される言語は、ローカル・マシンのロケール設定によって決まります。

コマンド・ライン・ツール・ヘルプの表示

コマンド・ラインの総合的なヘルプ情報を表示するには、コマンド apic --help または apic -h を入力します。 特定の apic コマンドのヘルプ情報を表示するには、コマンド apic command_name --help または apic command_name -h を入力します。

バージョン情報の表示

コマンド・ライン・ツールのバージョンを表示するには、コマンド apic --version を入力します。

構成変数の使用

一般的に使用されるプロパティーの値を構成変数に設定できます。 通常、コマンド・ラインのオプションを使用して値を指定するよりも、構成変数を設定する方がより簡単で一貫性があります。
注:

OpenAPI プロジェクトの構成変数は、常にグローバルです。 グローバル構成変数の値は、user-home-dir/.apiconnect/config ファイルに格納されます。ここで、user-home-dir はユーザーのホーム・ディレクトリーです。

構成変数を処理するには、次のコマンドを使用します。

  • apic config:get varname - 構成変数を取得します。 すべてのローカル構成変数の値を表示するには、apic config を使用します。また、すべてのグローバル構成変数の値を表示するには、apic config -g を使用します。
  • apic config:set varname - 指定された構成変数を設定または更新します。
  • apic config:delete varname - 指定された構成変数を削除します。
  • apic config:clear - すべての構成変数を削除します。

apic config:set コマンドを使用することで、構成プロパティーの値を設定します。 catalog や app などの構成プロパティーを設定しておくと、コマンドを入力する際に、これらのプロパティーの値を指定する必要がなくなります。

さらに、apic properties コマンドを使用して構成プロパティーを操作することもできます。
  • apic properties:clear - 構成プロパティーをクリアします。
  • apic properties:create - 名前/値の追加のペアを使用して構成プロパティーを拡張します。
  • apic properties:delete - 構成プロパティーを削除します。
  • apic properties:get - 構成プロパティーを取得します。
  • apic properties:list - 構成プロパティーをリストします。
  • apic properties:update - 構成プロパティーを更新します。
注:

CLI 構成プロパティーと同じ名前の環境変数がある場合、デフォルトで、そのスコープにある CLI コマンドの対応する CLI 構成プロパティーの値がその値によってオーバーライドされます。

例えば、SPACE という環境変数を定義した場合、デフォルトでは、space 構成プロパティーの設定に関係なく、次のコマンドの --space パラメーターの値に、その値が想定されます。
apic products:publish my_product.yaml --scope space

環境変数によって CLI 構成プロパティーがオーバーライドされないようにするには、APIC_LOAD_FROM_ENV という環境変数を定義して、値 false に設定します。

以下の表に、構成変数を示します。

表 1. 構成変数
変数名 説明 次のフラグの代わりに使用 (または次のフラグでオーバーライド)
カタログ カタログの側面を管理するすべてのコマンドのデフォルト・カタログ名。
カタログ値は、以下のいずれかとして指定できます。
  • サーバー名と組織名を含む完全なカタログ URI: mgmt-server/api/catalogs/org-name/catalog-name。 この場合、CLI 呼び出しを行うときに --catalog、 --organization、または --server を指定する必要はありません。これらの値は完全なカタログ URI に含まれているためです。
  • カタログ名 (例: sandbox)。 この場合でも、CLI 呼び出しを行うときに --organization および --server を指定する必要があります。
注: カタログ名 apic-dev は、ローカル・テスト用に予約されています。
  • 変数割り当てでカタログ URI が使用されている場合: --catalog, --organization, --server
  • 変数割り当てでカタログ名が使用されている場合: --catalog
クラウド クラウド管理コマンドのデフォルトの管理サーバー・ホスト名。 形式: mgmt-server/api/。 --server
消費者 API コンシューマーのデフォルト URI。 形式: mgmt-server/api/consumer-orgs/org-name/catalog-name/consumer-org-name。ここで、mgmt-server は管理サーバー、org-name は組織名、catalog-name はカタログ名、consumer-org-name はコンシューマー組織名です。 -–server, -–organization, -–catalog, -–consumer
モード CLI コマンドの --mode パラメーターのデフォルト値。 この値は、プロバイダー組織とコンシューマー組織のどちらでコマンドを実行するかに応じて、apim または consumer に設定します。 この変数を設定せず、コマンドで --mode パラメーターを指定しない場合は、値 apim が想定されます。 --mode
組織 (org) 組織を管理するすべてのコマンドのデフォルト組織名。

形式: mgmt-server/api/orgs/org-name。ここで、mgmt-server は管理サーバー、org-name は組織名です。

組織の値は、以下のいずれかとして指定できます。
  • サーバー名が含まれている完全な組織 URI: mgmt-server/api/orgs/org-name。 この場合、CLI 呼び出しを行うときに --server または --organization を指定する必要はありません。これらの値は完全な組織 URI に含まれているためです。
  • 組織の名前 (例: providerorg1)。 この場合でも、CLI 呼び出しを行うときに --server を指定する必要があります。
  • 変数割り当てで組織 URI が使用されている場合: --organization, --server
  • 変数割り当てで組織名が使用されている場合: --organization
スペース スペースの側面を管理するすべてのコマンドのデフォルトの スペース URI。

形式: mgmt-server/api/spaces/org-name/catalog-name/space-name(ここで、 mgmt-server は管理サーバー、 org-name は組織名、 catalog-name はカタログ名、 space-name は Space 名です)。

サーバー名にポート番号を追加できます (ポート番号がデフォルト値の 443 ではない場合)。

 --server, --organization, --catalog, --space
構成プロパティーを設定するには、以下のコマンドを入力します。
apic config:set name=value
ここで、name は構成プロパティーの名前であり、value は、その構成プロパティーに割り当てる値です。

例:

apic config:set catalog=sandbox

スクリプト・コマンド

多くの場合、一連の apic コマンドをシェル・スクリプトで自動化しておくと便利です。 apic ツールでは、まず対話式に使用条件に同意する必要があるため、最初に次のコマンドを使用する必要があります。
apic --accept-license
このコマンドを実行すると、スクリプトを非対話式に実行できるようになります。
使用分析の収集を無効にするには、次のコマンドを入力します。
apic --live-help

言語設定

--langフラグを使用することで、CLIコマンド出力の言語を設定できる。 このフラグにより、開発者ツールキットは指定された言語でコマンド出力を行うことができる。 以下の表はサポートされている言語です：

表 2. サポート対象言語
言語価値 言語
ja-jp 英語(米国)
cs チェコ語
ドイツ ドイツ語
スペイン スペイン語
フランス フランス語
それ イタリア語
ja 日本語
ko 韓国語
オランダ オランダ語
ポーランド ポーランド語
pt-br ポルトガル語 (ブラジル)
ロシア ロシア語
トルコ トルコ語
zh-cn 中国語 (簡体字)
zh-tw 中国語(繁体字)
ニーズに応じて言語価値を使い分けましょう。 フランス語を例に挙げよう。 言語をフランス語に設定するには、以下のコマンドを実行する：
apic --lang fr
コマンドを実行すると、出力がフランス語で表示される。 例:
apic config get invalid
Error: invalid n'est pas une variable de configuration valide
サポートされている言語ではない無効な値を入力した場合、システムは以下のエラーを表示します：
apic --lang invalid
Error: Value invalid is not valid for lang. Valid values are: en-us, cs, de, es, fr, it, ja, ko, nl, pl, pt-br, ru, tr, zh-cn, zh-tw