パフォーマンス情報の取得

機能

指定した仮想ホストのパフォーマンス情報を取得します。取得するデータが複数ある場合,最新の1件を取得します。

なお,次の場合,パフォーマンス情報は更新されません。

パフォーマンス情報を履歴として確認したい場合は,ITリソース管理者に依頼してください。ITリソース管理者は,レポート機能で履歴を取得してください。

取得する項目を次の表に示します。

項目説明
測定項目測定する項目名。
リソース管理画面の[パフォーマンス]タブに表示される[測定項目]のうち,次の項目を出力する。
  • CPU
    ゲストOSが認識しているCPU使用率。
  • MEMORY
    ゲストOSが認識しているメモリ使用率。
測定対象測定する対象。
リソース管理画面の[パフォーマンス]タブに表示される[測定対象]と同じ項目を出力する。
単位測定値の単位(単位:パーセント)。
リソース管理画面の[パフォーマンス]タブに表示される[測定対象]に対応した単位を出力する。
測定日時測定した日時。
測定値測定した値。
リソース管理画面の[パフォーマンス]タブに表示される[測定対象]の測定した値を出力する。

APIのサポートバージョン

このAPIは,01.00以降で提供します。

HTTPリクエスト形式

パフォーマンス情報を取得するAPIのHTTPリクエスト形式を次の表に示します。

項目
MethodGET
URI/jp1itrm/api/instances/リソースID/performances
Query String
(凡例)
-:なし。
注※
リクエストに使用するURIおよびQuery Stringは,APIクライアントで生成するのではなく,仮想ホストの一覧の取得で返却される「パフォーマンス情報へのリンク」を使用してリクエストしてください。

HTTPステータスコード

200 OK,またはエラーを示すステータスコードが出力されます。

詳細については,「API共通の仕様」の「HTTPステータスコード」を参照してください。

XMLのネームスペース

HTTPステータスコードが,200 OKの場合,http://www.hitachi.co.jp/soft/xml/jp1/itrm/api/performancesを使用します。

XMLのスキーマ

パフォーマンス情報を格納するスキーマを次の表に示します。

エレメント説明type出現回数
階層1階層2階層3階層4最小最大
performancesパフォーマンス情報の一覧。11
@hrefパフォーマンス情報へのリンクアドレス。
1,024文字以内の文字列で表す。
xs:string11
performanceパフォーマンス情報。
測定項目および測定対象の組み合わせに対して,1つのエレメントとなる。
00以上の任意の数字
@metric測定項目。
次の項目を表す。
  • CPU
    CPU使用率。
  • MEMORY
    メモリ使用率。
xs:string11
@instance_name測定対象。
255文字以内の文字列で表す。
xs:string11
@unit測定項目の単位を表す%という文字列。xs:string11
perf_dataパフォーマンスデータ。
データがない場合,このエレメントの個数は0となる。
00以上の任意の数字
@time測定日時。
ISO8601形式かつUTCで出力する。
xs:dateTime11
@value測定対象の測定値。
0以上の数値で表す。
xs:float11
(凡例)
-:なし。
注※
リンクアドレス中のサーバを示す部分には,ユーザー設定プロパティファイル(jp1itrm.properties)のCO.ITRMServerURLキーで設定されたものが使用されます。詳細については,「ユーザー設定プロパティファイル(jp1itrm.properties)」(2. 定義ファイル)を参照してください。

使用例

認証情報にユーザー名「portal01」,パスワード「password」を指定して,リソースID「1」の仮想ホストのパフォーマンス情報を取得する場合の使用例を示します。

GET△/jp1itrm/api/instances/1/performances△HTTP/1.0
Authorization:△Basic△cG9ydGFsMDE6cGFzc3dvcmQwMQ==

(凡例) △:半角スペース

出力例

リソースID「1」の仮想ホストのパフォーマンス情報を取得する場合の出力例を示します。

HTTP/1.1 200 OK
Content-Length: 459
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<performances href="http://localhost:23505/jp1itrm/api/instances/1/performances"
xmlns="http://www.hitachi.co.jp/soft/xml/jp1/itrm/api/performances">
<performance metric="CPU" instance_name="CPU" unit="%">
<perf_data time="2011-08-26T02:34:46.765Z" value="11.0" />
</performance>
<performance metric="MEMORY" instance_name="メモリ : 4.00 GB" unit="%">
<perf_data time="2011-08-26T02:34:46.765Z" value="40.0" />
</performance>
:
</performances>