はじめに
この記事では次のポイントを確認します。
- API Managerとは
- Managed APIの作成と実行
なお、この記事は次の記事の内容を理解していることを前提としています。
API Managerとは
API Manager(APIM)を利用して、Managed API(管理対象API)を作成することで次のような設定・機能を利用できます。
- 実行を許可するIPアドレスの指定
- 各認証方法のサポート(基本認証・OAuth 2.0認証・JSON Webトークン認証)
- 実行履歴の分析
- 実行元IPアドレスの確認
- 実行時の証方法の確認
- 実行に要した時間の確認
- 過去6ヶ月を対象とした実行履歴のダウンロード
上記機能のうち特に着目したい機能が 過去6ヶ月を対象とした実行履歴のダウンロード です。Managed APIを作成せずに、CAIプロセスをクラウドサーバーにデプロイしている場合、次の時間経過後、アプリケーション統合コンソールからログを参照できなくなります。
- 正常終了ステータス : 24時間
- エラー終了ステータス : 72時間
- 一時停止ステータス : 7日
CAIプロセスがエラーで終了していたとしても、例えばお正月休み中にログが消失してまうので、年明けの出社時に異常終了プロセスがあるか？を管理画面から確認できない状態となってしまいます。
Operational Insightを利用することで過去のCAIプロセス実行情報を参照できますが、実行統計は平均値のみ確認できる仕様となっています。
Managed APIを実行していると過去6カ月の実行情報を平均値ではなく、Managed APIの実行ステータスや処理時間などを個別に参照できるので、お正月休みも安心して過ごせることでしょう。
Managed APIの作成と実行
Managed APIの作成手順
今回は[CAIレシピ] プロセスの作成と実行(匿名認証と基本認証)で作成したCAIプロセス recipe-pcb-HelloWorld を対象にManaged APIを作成する手順を確認します。
-
IICSにログイン、 API Managerページ に切り替えます。
-
API Manager の画面に始めてアクセスすると次のような APIドメイン名 の構成画面が表示されると思います。
APIドメイン名は、Managed APIを実行する際のURLの一部に利用されます。特に要件が無い場合は、規定値のまま 保存 をクリックします。規定値には組織のOrgIDが含まれます(<OrgID>.com という形式)。 -
APIレジストリ タブから recipe-pcb-HelloWorld を探して右クリック、管理対象APIの作成 を選択します。今回は プロトコル=REST を対象にManaged APIを作成します。
-
作成 をクリックしてManaged APIを作成します。
-
正常にManaged APIが作成されると、一覧のステータスが アクティブ に変わります。
右クリックして編集を選択します。
-
全般タブでは、Managed APIの概要を確認できるほか、認証方法を変更することなどもできます。
API URLから管理対象をREST APIとして実行する時に必要となるURLを確認します。
Managed APIの実行
Managed APIを基本認証として実行する場合、確認したAPI URLを指定して次のように実行します。
// curl コマンド
curl -u username:password https://<IICS・APIMサーバー>/t/cai.recipe.com/recipe-pcb-HelloWorld
// 実行結果
{"out":"Hello World"}
Managed API実行結果の確認
Managed APIを実行すると 分析 - アクティビティログ からManaged APIの実行結果として、次のような情報を確認できます(括弧内の記載は各列の補足)。
- タイムスタンプ(Managed APIの実行日時)
- API名(実行したManaged APIの名前)
- プロトコル(実行時に利用されたプロトコル、REST or SOAP)
- HTTP応答(実行結果)
- IPアドレス
- 継続時間(実行時間)
