ドライブ情報の取得
機能
指定した仮想ホストのドライブ情報を取得します。
取得する項目を次の表に示します。
項目 | 説明 |
---|---|
種別 | ドライブ種別。 リソース管理画面の[ドライブ]タブに表示される[種別]と同じドライブ種別を出力する。 |
名前 | ドライブ名。 リソース管理画面の[ドライブ]タブに表示される[名前]と同じドライブ名を出力する。 |
状態 | ドライブの空き容量などの状態。 リソース管理画面の[ドライブ]タブに表示されるアイコンを次の文字列で出力する。
|
使用量 | ドライブ使用量(単位:バイト)。 リソース管理画面の[ドライブ]タブに表示される[使用量]と同じドライブ使用量を出力する。 |
空き容量 | ドライブ空き容量(単位:バイト)。 リソース管理画面の[ドライブ]タブに表示される[空き容量]と同じドライブ空き容量を出力する。 |
総容量 | ドライブ総容量(単位:バイト)。 リソース管理画面の[ドライブ]タブに表示される[総容量]と同じドライブ総容量を出力する。 |
ファイルシステム | ドライブのファイルシステム。 リソース管理画面の[ドライブ]タブに表示される[ファイルシステム]と同じドライブのファイルシステムを出力する。 |
ドライブタイプ | ドライブのタイプ。 リソース管理画面の[ドライブ]タブに表示される[ドライブタイプ]と同じドライブのタイプを出力する。 |
APIのサポートバージョン
このAPIは,01.00以降で提供します。
HTTPリクエスト形式
ドライブ情報を取得するAPIのHTTPリクエスト形式を次の表に示します。
項目 | 値 |
---|---|
Method | GET |
URI※ | /jp1itrm/api/instances/リソースID/storage_volumes |
Query String※ | - |
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 | - | - | - | ドライブ情報の一覧。 | - | 1 | 1 |
@href※ | - | - | ドライブ情報へのリンクアドレス。 1,024文字以内の文字列で表す。 | xs:string | 1 | 1 | |
storage_volume | - | - | ドライブ情報。 ドライブがない場合,このエレメントの個数は0となる。 | - | 0 | 0以上の任意の数字 | |
drive_category | - | ドライブ種別(FILESYSTEM)。 | xs:string | 1 | 1 | ||
drive_name | - | ドライブ名。 255文字以内の文字列で表す。 | xs:string | 1 | 1 | ||
drive_state | - | ドライブの状態。 次の状態を表す。
| xs:string | 1 | 1 | ||
drive_used | - | ドライブ使用量。 整数で表す。 | xs:long | 1 | 1 | ||
- | @unit | ドライブ使用量の単位を表すBYTEという文字列。 | xs:string | 1 | 1 | ||
drive_free | - | ドライブ空き容量。 0以上の数値で表す。 | xs:long | 1 | 1 | ||
- | @unit | ドライブ空き容量の単位を表すBYTEという文字列。 | xs:string | 1 | 1 | ||
drive_total | - | ドライブの総容量。 0以上の数値で表す。 | xs:long | 1 | 1 | ||
- | @unit | ドライブの総容量の単位を表すBYTEという文字列。 | xs:string | 1 | 1 | ||
file_system | - | ファイルシステム。 16文字以内の文字列で表す。 | xs:string | 1 | 1 | ||
drive_type | - | ドライブタイプ。 255文字以内の文字列で表す。 | xs:string | 1 | 1 |
使用例
認証情報にユーザー名「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>