ページの先頭行へ戻る
Interstage Application Server OLTPサーバ運用ガイド
Interstage

4.5.1 運用操作API群の機能概要

運用操作API群には、以下の機能があります。


運用APIでサポートしているワークユニット種別について

運用操作APIでサポートしているワークユニット種別は、以下のとおりです。

注意

Interstage運用APIでは、IJServerワークユニット(J2EEアプリケーション)の操作および情報取得は行えません。


4.5.1.1 Interstage運用API環境初期化・回収

ISOPenv関数は、Interstageの運用API環境初期化・回収機能を提供します。


Interstage運用API環境初期化

Interstage運用API環境を初期化します。Interstage運用APIを使用するには、本APIによりInterstage運用API環境の初期化が行われている必要があります。本APIは、アプリケーションプロセス内で、最初に、一度だけ発行してください。

Interstage運用API環境回収

Interstage運用API環境を回収します。アプリケーションプロセスの終了前に発行してください。


4.5.1.2 Interstage運用情報通知

ISOPnotify関数は、Interstageの運用情報通知機能を提供します。


ワークユニット名通知

API発行時に定義されているすべてのワークユニットに関する情報を通知します。本APIを繰り返し使用することによりワークユニット名の一覧を取り出すことができます。

本APIでは、ワークユニット名以外に以下の情報を通知します。

オブジェクト名通知

API発行時に定義されているオブジェクトに関する情報を通知します。本APIを繰り返し使用することにより指定したワークユニットに登録されているオブジェクト名の一覧を取り出すことができます。

本APIでは、オブジェクト名以外に以下の情報を通知します。

なお、指定されたワークユニットの種別により、通知する情報が異なります。

注意

  • プロセス多重度は、オブジェクトの形態が常駐型の場合と、非常駐型およびマルチオブジェクト常駐型の場合で意味が異なります。
    オブジェクトの形態が常駐型の場合は、指定されたオブジェクトのプロセス多重度です。
    非常駐型およびマルチオブジェクト常駐型の場合は、ワークユニット内に定義されている非常駐型のオブジェクト、またはマルチオブジェクト常駐型のオブジェクトすべてが同時に動作するプロセス多重度の最大数を意味します。

  • オブジェクト情報通知機能で獲得する非常駐型およびマルチオブジェクト常駐型のオブジェクトのキュー数、要求数はそれぞれのオブジェクトに対するものです。

  • ワークユニット種別がWRAPPERのオブジェクトの最大キューイング数とは、コンポーネントトランザクションサービスの環境定義に記述されたシステム最大保留セション数にあたります。この値はシステム全体の値であり、DPCF通信パスごとの最大値ではありません。
    ワークユニット定義で記述されているDPCF通信パス名がコンポーネントトランザクションサービスの環境定義に記述されている場合は、このシステム最大保留セション数を最大キューイング数として通知します。
    ワークユニット定義で記述されているDPCF通信パス名がコンポーネントトランザクションサービスの環境定義に記述されていない場合、このDPCF通信パスについては負荷抑制が行われません。この場合、システム最大保留セション数は無効な値となるため、最大キューイング数として0を通知します。


ワークユニット情報通知

API発行時のワークユニットの情報を通知します。通知する情報は、運用中、起動処理中、停止処理中、停止中(APIによる停止/コマンドによる停止/ワークユニット異常停止/自動停止)のいずれかです。

注意

自動停止はSolaris、Linuxのみです。


オブジェクト情報通知

API発行時のオブジェクトの情報を通知します。オブジェクトの状態以外に、以下の情報を通知します。

なお、指定されたオブジェクトが定義されているワークユニットの種別により、通知する情報が異なります。


インプリメンテーションリポジトリID内オブジェクト名通知

API発行時に指定したインプリメンテーションリポジトリIDに定義されているオブジェクトに関する情報を通知します。本APIを繰り返し使用することにより、インプリメンテーションリポジトリIDに定義されているオブジェクト名の一覧を取り出すことができます。

本APIでは、インプリメンテーションリポジトリID内オブジェクト名以外に以下の情報を通知します。

インプリメンテーションリポジトリID内オブジェクト情報通知

API発行時に指定したインプリメンテーションリポジトリIDに定義されているオブジェクトに関する情報を通知します。

指定されたオブジェクトの状態について、以下の情報を通知します。

4.5.1.3 Interstage運用操作

ISOPoperate関数は、Interstageの運用操作機能を提供します。


ワークユニット起動

ワークユニットを起動します。ワークユニットの起動は、同期的に実施します。
ワークユニットを起動することにより、サーバアプリケーションが起動されます。


ワークユニット停止

ワークユニットを停止します。ワークユニットの停止は同期的に実施します。
ワークユニットを停止することにより、サーバアプリケーションが停止します。tdstartwuコマンド/isstartwuコマンドから起動されたワークユニットも本APIから停止できます。


オブジェクト閉塞

指定されたオブジェクトを閉塞します。


オブジェクト閉塞解除

指定されたオブジェクトの閉塞を解除します。


4.5.1.4 Interstageシステム情報通知

ISOPsystem関数は、Interstageのシステム情報通知機能を提供します。


システム名一覧通知

API発行時に生成されているシステムの一覧を取り出すことができます。


システム名一覧解放

システム名一覧通知API発行時に獲得した領域を解放します。

注意

  • 本APIを使用する際に、Interstage運用API環境初期化の必要はありません。

  • 管理者権限で発行してください。