Jump To Close Expand all Collapse all Table of contents REST API ガイド 1. はじめに Expand section "1. はじめに" Collapse section "1. はじめに" 1.1. Representational State Transfer 1.2. Red Hat Enterprise Virtualization REST API の前提条件 2. 認証とセキュリティー Expand section "2. 認証とセキュリティー" Collapse section "2. 認証とセキュリティー" 2.1. TLS/SSL 証明書 2.2. HTTP 認証 2.3. 認証セッション 3. REST API クイックスタートの例 Expand section "3. REST API クイックスタートの例" Collapse section "3. REST API クイックスタートの例" 3.1. 例: API エントリーポイントへのアクセス 3.2. 例: データセンターコレクションの一覧表示 3.3. 例: ホストクラスターコレクションの一覧表示 3.4. 例: 論理ネットワークコレクションの一覧表示 3.5. 例: ホストコレクションの一覧表示 3.6. 例: CPU プロファイルの一覧表示 3.7. 例: ホストの承認 3.8. 例: NFS データストレージの作成 3.9. 例: NFS ISO ストレージの作成 3.10. 例: データセンターへのストレージドメインのアタッチ 3.11. 例: ストレージドメインのアクティブ化 3.12. 例: 仮想マシンの作成 3.13. 例: 仮想マシン NIC の作成 3.14. 例: 仮想マシン用ストレージディスクの作成 3.15. 例: 仮想マシンへの ISO イメージのアタッチ 3.16. 例: 仮想マシンの起動 3.17. 例: システムイベントのチェック 4. エントリーポイント Expand section "4. エントリーポイント" Collapse section "4. エントリーポイント" 4.1. 製品情報 4.2. リンクの要素 4.3. 特殊オブジェクトの要素 4.4. サマリーの要素 4.5. RESTful Service Description Language (RSDL) 4.6. Red Hat Enterprise Virtualization Windows ゲストの VSS サポート 4.7. QEMU ゲストエージェントの概要 4.8. VSS トランザクションフロー 5. 互換性レベルのバージョン Expand section "5. 互換性レベルのバージョン" Collapse section "5. 互換性レベルのバージョン" 5.1. 互換性レベルのアップグレード 6. 機能 Expand section "6. 機能" Collapse section "6. 機能" 6.1. バージョン依存の機能 6.2. 現行バージョン 6.3. 機能 7. 共通の機能 Expand section "7. 共通の機能" Collapse section "7. 共通の機能" 7.1. 要素のプロパティーを表すアイコン 7.2. 表現 Expand section "7.2. 表現" Collapse section "7.2. 表現" 7.2.1. 表現 7.2.2. リソース表現に共通の属性 7.2.3. リソース表現に共通の要素 7.3. コレクション Expand section "7.3. コレクション" Collapse section "7.3. コレクション" 7.3.1. コレクション 7.3.2. コレクション内の全リソースの一覧 7.3.3. 拡張リソースのサブコレクションの一覧 7.3.4. クエリーを使用したコレクションの検索 7.3.5. 検索結果の最大表示件数のパラメーター 7.3.6. 大文字と小文字の区別 7.3.7. クエリーの構文 7.3.8. ワイルドカード 7.3.9. ページネーション 7.3.10. コレクション内のリソース作成 7.3.11. 非同期要求 7.4. リソース Expand section "7.4. リソース" Collapse section "7.4. リソース" 7.4.1. リソース 7.4.2. リソースの取得 7.4.3. リソースの更新 7.4.4. リソースの削除 7.4.5. サブコレクションのリレーションシップ 7.4.6. XML 要素のリレーションシップ 7.4.7. アクション 7.4.8. パーミッション 7.4.9. エラーの処理 8. バックアップ/リストア API Expand section "8. バックアップ/リストア API" Collapse section "8. バックアップ/リストア API" 8.1. 仮想マシンのバックアップ 8.2. 仮想マシンの復元 9. データセンター Expand section "9. データセンター" Collapse section "9. データセンター" 9.1. データセンターの要素 9.2. データセンターの XML 表現 9.3. データセンターの JSON 表現 9.4. メソッド Expand section "9.4. メソッド" Collapse section "9.4. メソッド" 9.4.1. 新しいデータセンターの作成 9.4.2. データセンターの更新 9.4.3. データセンターの削除 9.5. サブコレクション Expand section "9.5. サブコレクション" Collapse section "9.5. サブコレクション" 9.5.1. ストレージドメインのサブコレクション Expand section "9.5.1. ストレージドメインのサブコレクション" Collapse section "9.5.1. ストレージドメインのサブコレクション" 9.5.1.1. ストレージドメインのサブコレクション 9.5.1.2. ストレージドメインのアタッチとデタッチ 9.5.1.3. アクション Expand section "9.5.1.3. アクション" Collapse section "9.5.1.3. アクション" 9.5.1.3.1. ストレージドメインをアクティブ化するアクション 9.5.1.3.2. ストレージドメインを非アクティブ化するアクション 9.5.2. ネットワークのサブコレクション Expand section "9.5.2. ネットワークのサブコレクション" Collapse section "9.5.2. ネットワークのサブコレクション" 9.5.2.1. ネットワークのサブコレクション 9.5.3. クォータのサブコレクション Expand section "9.5.3. クォータのサブコレクション" Collapse section "9.5.3. クォータのサブコレクション" 9.5.3.1. クォータのサブコレクション 9.6. アクション Expand section "9.6. アクション" Collapse section "9.6. アクション" 9.6.1. データセンターの強制削除のアクション 10. クラスター Expand section "10. クラスター" Collapse section "10. クラスター" 10.1. クラスターの要素 10.2. memory_policy 要素 10.3. スケジューリングポリシーの要素 10.4. クラスターの XML 表現 10.5. クラスターの JSON 表現 10.6. メソッド Expand section "10.6. メソッド" Collapse section "10.6. メソッド" 10.6.1. クラスターの作成 10.6.2. クラスターの更新 10.6.3. クラスターの削除 10.7. サブコレクション Expand section "10.7. サブコレクション" Collapse section "10.7. サブコレクション" 10.7.1. ネットワークのサブコレクション Expand section "10.7.1. ネットワークのサブコレクション" Collapse section "10.7.1. ネットワークのサブコレクション" 10.7.1.1. ネットワークのサブコレクション 10.7.2. ストレージボリュームのサブコレクション Expand section "10.7.2. ストレージボリュームのサブコレクション" Collapse section "10.7.2. ストレージボリュームのサブコレクション" 10.7.2.1. Red Hat Gluster Storage ボリュームのサブコレクション 10.7.2.2. ブリックサブコレクション 10.7.2.3. アクション Expand section "10.7.2.3. アクション" Collapse section "10.7.2.3. アクション" 10.7.2.3.1. start アクション 10.7.2.3.2. stop アクション 10.7.2.3.3. setOption アクション 10.7.2.3.4. resetOption アクション 10.7.2.3.5. resetAllOptions アクション 10.7.3. アフィニティーグループのサブコレクション Expand section "10.7.3. アフィニティーグループのサブコレクション" Collapse section "10.7.3. アフィニティーグループのサブコレクション" 10.7.3.1. アフィニティーグループのサブコレクション 11. ネットワーク Expand section "11. ネットワーク" Collapse section "11. ネットワーク" 11.1. ネットワークの要素 11.2. ネットワークリソースの XML 表現 11.3. ネットワークリソースの JSON 表現 11.4. メソッド Expand section "11.4. メソッド" Collapse section "11.4. メソッド" 11.4.1. ネットワークリソースの作成 11.4.2. ネットワークリソースの更新 11.4.3. ネットワークリソースの削除 11.5. サブコレクション Expand section "11.5. サブコレクション" Collapse section "11.5. サブコレクション" 11.5.1. ネットワーク VNIC プロファイルのサブコレクション 11.5.2. ネットワークラベルのサブコレクション 11.5.3. メソッド Expand section "11.5.3. メソッド" Collapse section "11.5.3. メソッド" 11.5.3.1. 論理ネットワークにラベルを付けるアクション 11.5.3.2. 論理ネットワークからのラベルの削除 12. ストレージドメイン Expand section "12. ストレージドメイン" Collapse section "12. ストレージドメイン" 12.1. ストレージドメインの要素 12.2. ストレージドメインの XML 表現 12.3. ストレージドメインの JSON 表現 12.4. メソッド Expand section "12.4. メソッド" Collapse section "12.4. メソッド" 12.4.1. ストレージドメインの作成 12.4.2. ストレージドメインの更新 12.4.3. ストレージドメインの削除 12.5. ストレージタイプ Expand section "12.5. ストレージタイプ" Collapse section "12.5. ストレージタイプ" 12.5.1. ストレージタイプ 12.5.2. NFS ストレージ 12.5.3. PosixFS ストレージ 12.5.4. iSCSI および FCP のストレージ 12.5.5. LocalFS ストレージ 12.6. エクスポートストレージドメイン Expand section "12.6. エクスポートストレージドメイン" Collapse section "12.6. エクスポートストレージドメイン" 12.6.1. エクスポートストレージドメイン 12.7. Glance イメージストレージドメイン Expand section "12.7. Glance イメージストレージドメイン" Collapse section "12.7. Glance イメージストレージドメイン" 12.7.1. Glance イメージストレージドメイン 12.8. サブコレクション Expand section "12.8. サブコレクション" Collapse section "12.8. サブコレクション" 12.8.1. ファイルのサブコレクション 12.9. アクション Expand section "12.9. アクション" Collapse section "12.9. アクション" 12.9.1. 既存のストレージドメインのインポート 12.9.2. ストレージドメインの削除 13. ストレージ接続 Expand section "13. ストレージ接続" Collapse section "13. ストレージ接続" 13.1. ストレージ接続の要素 13.2. ストレージ接続リソースの XML 表現 13.3. メソッド Expand section "13.3. メソッド" Collapse section "13.3. メソッド" 13.3.1. 新規ストレージ接続の作成 13.3.2. ストレージ接続の削除 13.3.3. ストレージ接続の更新 13.3.4. iSCSI ストレージ接続の更新 13.3.5. 既存のストレージ接続を使用する新規ストレージドメインの追加 13.3.6. iSCSI ストレージへの追加ストレージ接続のアタッチ 13.3.7. iSCSI ストレージからのストレージ接続のデタッチ 13.3.8. iSCSI ターゲットへの認証情報の定義 14. ホスト Expand section "14. ホスト" Collapse section "14. ホスト" 14.1. ホストの要素 14.2. ホストの XML 表現 14.3. ホストの JSON 表現 14.4. 電源管理の要素 14.5. メモリー管理の要素 14.6. メソッド Expand section "14.6. メソッド" Collapse section "14.6. メソッド" 14.6.1. ホストの作成 14.6.2. ホストの更新 14.6.3. ホストの削除 14.7. サブコレクション Expand section "14.7. サブコレクション" Collapse section "14.7. サブコレクション" 14.7.1. ホストのネットワークアタッチメントのサブコレクション 14.7.2. ホストのネットワークインターフェースのサブコレクション Expand section "14.7.2. ホストのネットワークインターフェースのサブコレクション" Collapse section "14.7.2. ホストのネットワークインターフェースのサブコレクション" 14.7.2.1. ホストのネットワークインターフェースのサブコレクション 14.7.2.2. ボンディングインターフェース 14.7.2.3. ネットワークインターフェースのネットワークアタッチメント Expand section "14.7.2.3. ネットワークインターフェースのネットワークアタッチメント" Collapse section "14.7.2.3. ネットワークインターフェースのネットワークアタッチメント" 14.7.2.3.1. ネットワークインターフェースのネットワークアタッチメント 14.7.2.3.2. ネットワークアタッチメントのカスタムプロパティー 14.7.2.4. ネットワークインターフェースのラベル 14.7.2.5. ネットワークインターフェースの統計 14.7.3. ストレージのサブコレクション 14.7.4. ホスト NUMA ノードのサブコレクション Expand section "14.7.4. ホスト NUMA ノードのサブコレクション" Collapse section "14.7.4. ホスト NUMA ノードのサブコレクション" 14.7.4.1. NUMA ノードのサブコレクション 14.7.4.2. NUMA ノードの統計 14.7.5. ホスト統計のサブコレクション Expand section "14.7.5. ホスト統計のサブコレクション" Collapse section "14.7.5. ホスト統計のサブコレクション" 14.7.5.1. ホスト統計のサブコレクション 14.8. アクション Expand section "14.8. アクション" Collapse section "14.8. アクション" 14.8.1. VDSM をインストールするアクション 14.8.2. ホストをアクティブ化するアクション 14.8.3. ホストネットワークの設定アクション 14.8.4. ホストをフェンスするアクション 14.8.5. ホストを非アクティブ化するアクション 14.8.6. ホストを承認するアクション 14.8.7. ホストの iSCSI ログインのアクション 14.8.8. ホストの iSCSI 検出のアクション 14.8.9. ネットワーク設定をコミットするアクション 14.8.10. SPM の設定 15. 仮想マシン Expand section "15. 仮想マシン" Collapse section "15. 仮想マシン" 15.1. 仮想マシンの要素 15.2. 仮想マシンの XML 表現 15.3. 仮想マシンの追加 OVF データの XML 表現 15.4. 仮想マシンの JSON 表現 15.5. メソッド Expand section "15.5. メソッド" Collapse section "15.5. メソッド" 15.5.1. 仮想マシンの作成 15.5.2. 仮想マシンの更新 15.5.3. 仮想マシンの削除 15.5.4. 仮想ディスクを削除せずに仮想マシンを削除する方法 15.6. サブコレクション Expand section "15.6. サブコレクション" Collapse section "15.6. サブコレクション" 15.6.1. ディスクのサブコレクション Expand section "15.6.1. ディスクのサブコレクション" Collapse section "15.6.1. ディスクのサブコレクション" 15.6.1.1. ディスクのサブコレクション 15.6.1.2. ディスクのクローン作成 15.6.1.3. ディスク統計のサブコレクション 15.6.1.4. フローティングディスクのアタッチおよびデタッチのアクション 15.6.1.5. ディスクのアクティブ化および非アクティブ化のアクション 15.6.2. ネットワークインターフェースのサブコレクション Expand section "15.6.2. ネットワークインターフェースのサブコレクション" Collapse section "15.6.2. ネットワークインターフェースのサブコレクション" 15.6.2.1. ネットワークインターフェースのサブコレクション 15.6.2.2. ネットワークインターフェース統計のサブコレクション 15.6.3. 仮想 NUMA ノードのサブコレクション 15.6.4. CD-ROM のサブコレクション 15.6.5. スナップショットのサブコレクション Expand section "15.6.5. スナップショットのサブコレクション" Collapse section "15.6.5. スナップショットのサブコレクション" 15.6.5.1. スナップショットのサブコレクション 15.6.5.2. スナップショットから仮想マシンのクローンを作成します。 15.6.6. 統計のサブコレクション 15.6.7. 仮想マシンのセッション情報の表示 15.7. アクション Expand section "15.7. アクション" Collapse section "15.7. アクション" 15.7.1. 仮想マシンを起動するアクション 15.7.2. Cloud-Init アクションでの仮想マシンの起動 15.7.3. 仮想マシンを停止するアクション 15.7.4. 仮想マシンをシャットダウンするアクション 15.7.5. 仮想マシンを一時停止するアクション 15.7.6. 仮想マシンを再起動するアクション 15.7.7. 外部コンソールから仮想マシンへアクセスするためにユーザーログオンを有効にするアクション 15.7.8. 仮想マシンをプールからデタッチするアクション 15.7.9. 仮想マシンを移行するアクション 15.7.10. 仮想マシンの移行をキャンセルするアクション 15.7.11. 仮想マシンをエクスポートするアクション 15.7.12. 仮想マシンのチケットのアクション 15.7.13. 仮想マシンを強制削除するアクション 15.7.14. 仮想マシンのファイルシステムのフリーズアクション 15.7.15. 仮想マシンのファイルシステムアクション 16. フローティングディスク Expand section "16. フローティングディスク" Collapse section "16. フローティングディスク" 16.1. フローティングディスクの要素 16.2. フローティングディスクの XML 表現 16.3. メソッド Expand section "16.3. メソッド" Collapse section "16.3. メソッド" 16.3.1. フローティングディスクの作成 16.4. サブコレクション Expand section "16.4. サブコレクション" Collapse section "16.4. サブコレクション" 16.4.1. 統計のサブコレクション 16.5. アクション Expand section "16.5. アクション" Collapse section "16.5. アクション" 16.5.1. フローティングディスクのコピー 17. テンプレート Expand section "17. テンプレート" Collapse section "17. テンプレート" 17.1. 仮想マシンテンプレートの要素 17.2. 仮想マシンのテンプレートの XML 表現 17.3. メソッド Expand section "17.3. メソッド" Collapse section "17.3. メソッド" 17.3.1. 新規のテンプレートの作成 17.3.2. 新しいテンプレートのサブバージョンの作成 17.3.3. テンプレートの更新 17.3.4. テンプレートのサブバージョンの更新 17.3.5. テンプレートの削除 17.4. アクション Expand section "17.4. アクション" Collapse section "17.4. アクション" 17.4.1. テンプレートをエクスポートするアクション 18. 仮想マシンのプール Expand section "18. 仮想マシンのプール" Collapse section "18. 仮想マシンのプール" 18.1. 仮想マシンプールの要素 18.2. 仮想マシンプールの XML 表現 18.3. メソッド Expand section "18.3. メソッド" Collapse section "18.3. メソッド" 18.3.1. 新規仮想マシンプールの作成 18.3.2. 仮想マシンプールの更新 18.3.3. 仮想マシンプールの削除 18.4. アクション Expand section "18.4. アクション" Collapse section "18.4. アクション" 18.4.1. 仮想マシンを割り当てるアクション 19. ドメイン Expand section "19. ドメイン" Collapse section "19. ドメイン" 19.1. ドメインの要素 19.2. ドメインリソースの XML 表現 19.3. サブコレクション Expand section "19.3. サブコレクション" Collapse section "19.3. サブコレクション" 19.3.1. ドメインユーザーのサブコレクション 19.3.2. ドメイングループのサブコレクション 20. グループ Expand section "20. グループ" Collapse section "20. グループ" 20.1. インポートしたグループの要素 20.2. グループリソースの XML 表現 20.3. ディレクトリーサービスからのグループの追加 21. ロール Expand section "21. ロール" Collapse section "21. ロール" 21.1. ロールの要素 21.2. ロールコレクションの XML 表現 21.3. メソッド Expand section "21.3. メソッド" Collapse section "21.3. メソッド" 21.3.1. ロールの作成 21.3.2. ロールの更新 21.3.3. ロールの削除 21.4. ロールの permits のサブコレクション Expand section "21.4. ロールの permits のサブコレクション" Collapse section "21.4. ロールの permits のサブコレクション" 21.4.1. ロールの permits のサブコレクション 21.4.2. ロールへの permit の割り当て 21.4.3. ロールからの permit の削除 22. ユーザー Expand section "22. ユーザー" Collapse section "22. ユーザー" 22.1. ユーザーの要素 22.2. ユーザーリソースの XML 表現 22.3. メソッド Expand section "22.3. メソッド" Collapse section "22.3. メソッド" 22.3.1. ユーザーの追加 22.3.2. ユーザーへのロールの追加 23. タグ Expand section "23. タグ" Collapse section "23. タグ" 23.1. タグの要素 23.2. タグリソースの XML 表現 23.3. タグの関連付け Expand section "23.3. タグの関連付け" Collapse section "23.3. タグの関連付け" 23.3.1. ホスト、ユーザー、仮想マシンへのタグの関連付け 23.3.2. タグの削除 23.3.3. タグ付けしたリソースのコレクションに対するクエリーの実行 23.4. 親タグ Expand section "23.4. 親タグ" Collapse section "23.4. 親タグ" 23.4.1. 親タグ 23.4.2. 親タグの設定 23.4.3. 親タグの変更 24. イベント Expand section "24. イベント" Collapse section "24. イベント" 24.1. イベントの要素 24.2. イベントコレクションの XML 表現 24.3. 仮想マシン作成イベントの XML 表現 24.4. メソッド Expand section "24.4. メソッド" Collapse section "24.4. メソッド" 24.4.1. イベントの検索 24.4.2. イベントのページネーション処理 24.4.3. イベントの追加 24.4.4. イベントの削除 A. cURL での API の使用法 Expand section "A. cURL での API の使用法" Collapse section "A. cURL での API の使用法" A.1. cURL での API の使用法 A.2. cURL のインストール A.3. cURL の使用法 A.4. 例 Expand section "A.4. 例" Collapse section "A.4. 例" A.4.1. cURL を使用した GET 要求 A.4.2. cURL を使用した POST 要求 A.4.3. cURL を使用した PUT 要求 A.4.4. cURL を使用した DELETE 要求 A.4.5. cURL を使用した 本文付きの DELETE 要求 B. 列挙値の変換 Expand section "B. 列挙値の変換" Collapse section "B. 列挙値の変換" B.1. 列挙値の変換 C. イベントコード Expand section "C. イベントコード" Collapse section "C. イベントコード" C.1. イベントコード D. タイムゾーン Expand section "D. タイムゾーン" Collapse section "D. タイムゾーン" D.1. タイムゾーン E. 改訂履歴 法律上の通知 Settings Close Language: 日本語 简体中文 English Language: 日本語 简体中文 English Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF Language and Page Formatting Options Language: 日本語 简体中文 English Language: 日本語 简体中文 English Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF 6.2. 現行バージョン current 要素は、指定された version がサポートされている最新の互換性レベルであるかどうかを表します。値は true または false のいずれかのブール値です。 <capabilities> <version major="3" minor="5"> ... <current>true</current> ... </version> </capabilities> Previous Next