ドライブ情報の取得

機能

指定した仮想ホストのドライブ情報を取得します。

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

項目説明
種別ドライブ種別。
リソース管理画面の[ドライブ]タブに表示される[種別]と同じドライブ種別を出力する。
名前ドライブ名。
リソース管理画面の[ドライブ]タブに表示される[名前]と同じドライブ名を出力する。
状態ドライブの空き容量などの状態。
リソース管理画面の[ドライブ]タブに表示されるアイコンを次の文字列で出力する。
  • NORMAL
    正常。
  • WARNING
    警告。
  • ERROR
    異常。
  • UNKNOWN
    不明。
  • NOT_MONITORED
    監視停止。
  • NOT_COLLECTED
    収集しない。
アイコンの意味については,マニュアル「JP1/IT Resource Management - Manager 設計・構築ガイド」のドライブ情報の表示について説明している個所を参照してください。
使用量ドライブ使用量(単位:バイト)。
リソース管理画面の[ドライブ]タブに表示される[使用量]と同じドライブ使用量を出力する。
空き容量ドライブ空き容量(単位:バイト)。
リソース管理画面の[ドライブ]タブに表示される[空き容量]と同じドライブ空き容量を出力する。
総容量ドライブ総容量(単位:バイト)。
リソース管理画面の[ドライブ]タブに表示される[総容量]と同じドライブ総容量を出力する。
ファイルシステムドライブのファイルシステム。
リソース管理画面の[ドライブ]タブに表示される[ファイルシステム]と同じドライブのファイルシステムを出力する。
ドライブタイプドライブのタイプ。
リソース管理画面の[ドライブ]タブに表示される[ドライブタイプ]と同じドライブのタイプを出力する。

APIのサポートバージョン

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

HTTPリクエスト形式

ドライブ情報を取得するAPIのHTTPリクエスト形式を次の表に示します。

項目
MethodGET
URI/jp1itrm/api/instances/リソースID/storage_volumes
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/storage_volumesを使用します。

XMLのスキーマ

ドライブ情報を格納するスキーマを次の表に示します。

エレメント説明type出現回数
階層1階層2階層3階層4最小最大
storage_volumesドライブ情報の一覧。11
@hrefドライブ情報へのリンクアドレス。
1,024文字以内の文字列で表す。
xs:string11
storage_volumeドライブ情報。
ドライブがない場合,このエレメントの個数は0となる。
00以上の任意の数字
drive_categoryドライブ種別(FILESYSTEM)。xs:string11
drive_nameドライブ名。
255文字以内の文字列で表す。
xs:string11
drive_stateドライブの状態。
次の状態を表す。
  • NORMAL
    正常。
  • WARNING
    警告。
  • ERROR
    異常。
  • UNKNOWN
    状態不明。
  • NOT_MONITORED
    監視停止。
  • NOT_COLLECTED
    収集しない。
xs:string11
drive_usedドライブ使用量。
整数で表す。
xs:long11
@unitドライブ使用量の単位を表すBYTEという文字列。xs:string11
drive_freeドライブ空き容量。
0以上の数値で表す。
xs:long11
@unitドライブ空き容量の単位を表すBYTEという文字列。xs:string11
drive_totalドライブの総容量。
0以上の数値で表す。
xs:long11
@unitドライブの総容量の単位を表すBYTEという文字列。xs:string11
file_systemファイルシステム。
16文字以内の文字列で表す。
xs:string11
drive_typeドライブタイプ。
255文字以内の文字列で表す。
xs:string11
(凡例)
-:なし。
注※
リンクアドレス中のサーバを示す部分には,ユーザー設定プロパティファイル(jp1itrm.properties)のCO.ITRMServerURLキーで設定されたものが使用されます。詳細については,「ユーザー設定プロパティファイル(jp1itrm.properties)」(2. 定義ファイル)を参照してください。

使用例

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

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

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

出力例

リソースID「1」の仮想ホストのドライブ情報を取得する場合の出力例を示します。

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

<?xml version="1.0" encoding="UTF-8" ?>
<storage_volumes href="http://localhost:23505/jp1itrm/api/instances/1/storage_volumes"
xmlns="http://www.hitachi.co.jp/soft/xml/jp1/itrm/api/storage_volumes">
<storage_volume>
<drive_category>FILESYSTEM</drive_category>
<drive_name>C:</drive_name>
<drive_state>NORMAL</drive_state>
<drive_used unit="BYTE">12345678</drive_used>
<drive_free unit="BYTE">87654321</drive_free>
<drive_total unit="BYTE">99999999</drive_total>
<file_system>NTFS</file_system>
<drive_type>Local</drive_type>
</storage_volume>
<storage_volume>
:
</storage_volume>
:
</storage_volumes>