仮想ホストの一覧の取得
機能
次の条件をすべて満たす仮想ホストの一覧を取得します。仮想ホスト以外のITリソースは取得しません。
条件に一致した仮想ホストがJP1/ITRM上に登録されていない場合は,0件となります。
取得する項目を次の表に示します。
項目 | 説明 |
---|---|
リソースID | システムで自動的に割り振られたリソースID。仮想ホストを一意に表す。 |
リソース名 | 仮想ホストのリソース名。 リソース管理画面のリソース一覧エリアに表示される[リソース名]と同じリソース名を出力する。 |
ホスト名 | 仮想ホストのホスト名。 [リソース編集]画面の[ホスト名]と同じホスト名を出力する。 |
電源状態※1 | 仮想ホストの電源状態。 仮想ホストの状態によって,次の文字列を出力する。
|
OS | 仮想ホスト上のOSの名称(ゲストOSが認識しているOSの名称)。 リソース管理画面のリソース一覧エリアに表示される[OS]と同じOS名を出力する。 |
予約ID | システムで自動的に割り振られた予約を示す値。 スケジュール画面の予約一覧エリアに表示される[予約ID]と同じ予約IDを出力する。 |
予約名 | 予約名称。 スケジュール画面の予約一覧エリアに表示される[予約名]と同じ予約名を出力する。 |
業務グループID | システムで自動的に割り振られた業務グループID。予約に対応する業務グループを一意に表す。 |
業務グループ名 | 予約に対応する業務グループの名称。 スケジュール画面の予約一覧エリアに表示される[業務グループ]と同じ業務グループ名を出力する。 |
予約コメント | 予約に対応するコメント。 スケジュール画面の予約一覧エリアに表示される[コメント]と同じコメントを出力する。 |
個別予約期間名 | 個別予約の期間名。 スケジュール画面の[すべて]タブに表示される[予約名]と同じ予約名を出力する。 |
個別予約開始日時 | 個別予約の開始日時。 スケジュール画面の[すべて]タブに表示される[開始日時]と同じ日時を出力する。 |
個別予約終了日時 | 個別予約の終了日時。 スケジュール画面の[すべて]タブに表示される[終了日時]と同じ日時を出力する。 |
システム情報へのリンク※2 | システム情報を取得するAPIへのリンクアドレス。 |
パフォーマンス情報へのリンク※2 | パフォーマンス情報を取得するAPIへのリンクアドレス。 |
ドライブ情報へのリンク※2 | ドライブ情報を取得するAPIへのリンクアドレス。 |
仮想ホスト操作へのリンク※2 | 起動・停止・リブートするAPIへのリンクアドレス。 |
APIのサポートバージョン
このAPIは,01.00以降で提供します。
HTTPリクエスト形式
仮想ホストの一覧を取得するAPIのHTTPリクエスト形式を次の表に示します。
項目 | 値 |
---|---|
Method | GET |
URI※ | /jp1itrm/api/instances |
Query String※ | realm=業務グループID |
HTTPステータスコード
200 OK,またはエラーを示すステータスコードが出力されます。
詳細については,「API共通の仕様」の「HTTPステータスコード」を参照してください。
XMLのネームスペース
HTTPステータスコードが,200 OKの場合,http://www.hitachi.co.jp/soft/xml/jp1/itrm/api/instancesを使用します。
XMLのスキーマ
仮想ホストの一覧を格納するスキーマを次の表に示します。
エレメント | 説明 | type | 出現回数 | ||
---|---|---|---|---|---|
階層1 | 階層2 | 最小 | 最大 | ||
instances | - | 仮想ホストの一覧。 | - | 1 | 1 |
instance | 仮想ホストの情報。 条件に一致する仮想ホストがJP1/ITRM上に1つも登録されていない場合,このエレメントの個数は0となる。 この配下の情報については,「システム情報の取得」(4. API)の「XMLのスキーマ」を参照。 | - | 0 | 0以上の任意の数字 |
使用例
認証情報にユーザー名「portal01」,パスワード「password」を指定して,業務グループID「1」の仮想ホストの一覧を取得する場合の使用例を示します。
GET△/jp1itrm/api/instances?realm=1△HTTP/1.0
Authorization:△Basic△cG9ydGFsMDE6cGFzc3dvcmQwMQ==
(凡例) △:半角スペース
出力例
業務グループID「1」の仮想ホストの一覧を取得する場合の出力例を示します。
HTTP/1.1 200 OK
Content-Length: 1639
Content-Type: application/xml
<?xml version="1.0" encoding="UTF-8" ?>
<instances xmlns="http://www.hitachi.co.jp/soft/xml/jp1/itrm/api/instances">
<instance href="http://localhost:23505/jp1itrm/api/instances/1" id="1">
<name>VM001</name>
<hostname>HOST_01</hostname>
<state>ON</state>
<os>Microsoft Windows Server 2008 R2 Enterprise</os>
<reservations>
<reservation id="123" name="aaa" realm_id="456" realm_name="第一開発/1課/グループA" comment="ccc"
period_name="yoyaku"
start_time="2011-09-10T23:59:48.812Z" end_time="2011-09-10T23:59:48.812Z" />
<reservation id="777" name="bbb" realm_id="888" realm_name="第一開発/1課/グループB" comment="dd"
period_name="yoyaku2"
start_time="2011-09-10T23:59:48.812Z" end_time="2011-09-10T23:59:48.812Z" />
</reservations>
<performance href="http://localhost:23505/jp1itrm/api/instances/1/performances" />
<storage_volume href="http://localhost:23505/jp1itrm/api/instances/1/storage_volumes" />
<actions>
<link rel="start" method="post"
href="http://localhost:23505/jp1itrm/api/instances/1/start?realm=1" />
<link rel="stop" method="post"
href="http://localhost:23505/jp1itrm/api/instances/1/stop?realm=1" />
<link rel="powerOff" method="post"
href="http://localhost:23505/jp1itrm/api/instances/1/powerOff?realm=1" />
<link rel="reboot" method="post"
href="http://localhost:23505/jp1itrm/api/instances/1/reboot?realm=1" />
<link rel="reset" method="post"
href="http://localhost:23505/jp1itrm/api/instances/1/reset?realm=1" />
</actions>
</instance>
<instance href="http://localhost:23505/jp1itrm/api/instances/2" id="2">
<name>VM002</name>
:
</instance>
:
</instances>