モニタリング API リファレンスガイド

CA AppLogic®

3.5

CA Technologies

モニタリング API 概要

MON アプライアンスは、その aux 出力端子上で接続されたアプライアンスから収集されたカウンタデータおよび設定をエクスポートします。これは、カスタムの REST ベースのプロトコルを使用して、HTTP 上で実行されます。このプロトコルは、以下の 3 つのタイプのリソースを定義します。

アプライアンス
エンティティ
カウンタ

これらの各タイプは、それまでのスコープに組み込まれます。つまり、エンティティはアプライアンスのスコープでのみ意味を持ち、カウンタは特定のエンティティのスコープでのみ意味を持ちます。データ収集 API を使用すると、MON に認識されるすべてのカウンタの設定および値を取得することができます。

MON では、リクエストされたデータ設定および値を、以下のいずれかの構造化テキスト形式でエクスポートします。

XML （特定の形式が fmt 引数を通じてリクエストされない場合に主に使用される形式）
UDL （CA AppLogic 内部使用）
JSON （JavaScript 対応のブラウザクライアント用）

モニタリング API プロトコル

このプロトコルは、読み取り機能のみを提供するので、GET HTTP メソッドのみが使用されます。したがって、サポートされているすべてのタイプのプロトコルで、リクエストはその URI および出力構造によって定義できます。文字は URI では「特殊」と認識されるため、標準的な % エンコーディングを使用してエスケープする必要があります。その出力は XML スキーマによって定義します（主な出力形式は XML です）。他の出力形式（UDL、JSON）への変換は、それぞれの出力形式の表現構造の方法および属性を直接使用することによって行われます（例： UDL エンティティと XML エンティティ、UDL 属性と XML 属性、JSON オブジェクトと XML エンティティ、JSON オブジェクトプロパティと XML 属性）。

すべての出力のルートノードには、タイムスタンプ属性が含まれており、レスポンスが作成された時点のサーバの時間が提供されます。

以下で、サポートされるすべての URL （コール）について説明します。

カウンタ設定コール

/monapi/desc[?fmt=<format>]

すべての利用可能なアプライアンスのリストを、指定された出力形式で返します（<format> は、xml など既知の出力形式の 1 つです）。

出力：

<response timestamp="1194967464">
   <appliance name="main.web" />
   <appliance name="main.in" />
</response>

/monapi/desc/<apps>[?fmt=<format>]

リクエストされたアプライアンス（<apps>）に含まれる利用可能なすべてのエンティティのリストを返します。 <apps> には、単一のアプライアンス名、アプライアンス名のカンマ区切りリスト、または利用可能なすべてのアプライアンスを意味するワイルドカード文字（*）を指定できます。

出力：

<response timestamp="1194967464">
   <appliance name="main.web">
      <entity name="Terminal in" />
      <entity name="Terminal out" />
      <entity name="Volume data" />
      <entity name="CPU" />
      <entity name="Memory" />
      <entity name="Network" />
   </appliance>
</response>
/monapi/desc/<apps>/<ents>[?fmt=<format>]

リクエストされたアプライアンスエンティティ（<ents>）に含まれる利用可能なすべてのカウンタのリストを返します。 <ents> には、単一のエンティティ名、エンティティ名のカンマ区切りリスト、または利用可能なすべてのエンティティを意味するワイルドカード文字（*）を指定できます。 <apps> と同じです。

出力：

<response timestamp="1194967464">
   <appliance name="main.web">
      <entity name="Terminal in">
         <counter name="Sent bytes" />
         <counter name="Received bytes" />
      </entity>
   </appliance>
</response>
/monapi/desc/<apps>/<ents>/<cnts>[?fmt=<format>]

リクエストされたカウンタ（<cnts>）の説明を返します。 <ents>、<ents>、および <ents> には、単一のアプライアンス/エンティティ/カウンタ、それらのカンマ区切りリスト、またはワイルドカードを指定できます。

出力：

<response timestamp="1194967464">
   <appliance name="main.web">
      <entity name="Terminal in">
         <counter name="Sent bytes" description="" units="" alarm_below="" alarm_above="" range_lower="" range_upper="" pace="" />
         <counter name="Received bytes" description="" units="" alarm_below="" alarm_above="" range_lower="" range_upper="" pace="" />
      </entity>
   </appliance>
</response>

カウンタ値コール

/monapi/val/<apps>/<ents>/<cnts>[?fmt=<format>]

指定されたカウンタの値を返します。 app、ent、または cnt パラメータのいずれかが省略された場合、ワイルドカード値と見なされます。したがって、たとえば、/monapi/val/main.web は、「アプライアンス main.web のすべてのエンティティ内の全カウンタの値」を意味します。

出力：

<response timestamp="1194967464">
   <appliance name="main.web">
      <entity name="Terminal in">
         <counter name="Sent bytes" value="23234" />
         <counter name="Received bytes" value="690432" />
      </entity>
   </appliance>
</response>