Hitachi

JP1 Version 12 JP1/Automatic Job Management System 3 コマンドリファレンス


6.1 API利用の流れ

JP1/AJS3で公開されているAPIを使用して,任意のユーザーアプリケーションからJP1/AJS3 - Managerのユニットを実行したり監視したりできます。ここでは,APIの利用の流れを説明します。

ユーザーアプリケーションは,HTTP通信のできる任意のプログラミング言語で作成します。ユーザーアプリケーションからリクエストを発行する際は, JP1ユーザーの認証情報を指定します。リクエストを発行すると,Web ConsoleサーバおよびJP1/AJS3 - Managerを経由して,JP1/Baseでユーザー認証が行われます。認証が成功すると,JP1/AJS3 - Managerで処理が実行され,ユーザーアプリケーションにレスポンスが返却されます。この認証は,リクエストを発行するたびに実施されます。処理の流れを次の図に示します。

図6‒1 API利用の流れ

[図データ]

APIを使ったユーザーアプリケーションでできることについては,マニュアル「JP1/Automatic Job Management System 3 導入ガイド 8.3 ユーザーアプリケーションによるJP1/AJS3の操作」を参照してください。

補足事項
  • APIで使用する通信プロトコルは,HTTP/1.1です。通信プロトコルについては,次の規定を参照してください。

    ・HTTPプロトコルの場合

     RFC2616

    ・HTTPSプロトコルの場合

     RFC2818

  • JP1/AJS3では,ユーザーアプリケーションからのAPIの実行を制限することもできます。また,リクエストを発行できるJP1/AJS3 - Managerを制限することもできます。

    APIの実行制限機能と,接続先JP1/AJS3 - Managerの制限機能は,Web Consoleサーバの環境設定ファイル(ajs3web.conf)の設定を変更することで有効にします。環境設定ファイル(ajs3web.conf)の詳細については,マニュアル「JP1/Automatic Job Management System 3 構築ガイド 3.4.3 環境設定ファイル(ajs3web.conf)の設定項目の詳細」(Windowsの場合),またはマニュアル「JP1/Automatic Job Management System 3 構築ガイド 13.3.3 環境設定ファイル(ajs3web.conf)の設定項目の詳細」(Linuxの場合)を参照してください。