CFMG APIは、以下のAPIから構成されています。
分類 | CFMG API名 | 機能概要 |
|---|---|---|
システムテンプレートの操作 | ListVSYSDescriptor | システムテンプレート一覧を取得する |
ListDiskImage | クローニングマスタ一覧を取得する | |
ListServerType | L-Serverテンプレート一覧を取得する | |
GetVSYSDescriptorConfiguration | テンプレートの構成情報(サーバ構成、ネットワーク構成など)を取得する | |
GetVSYSDescriptorAttributes | テンプレートの属性(テンプレート名など)を取得する | |
GetPoolList | リソースプールの一覧を取得する | |
仮想システム操作 | CreateVSYS | 仮想システムを作成する |
ListVSYS | 仮想システムの一覧を取得する | |
DestroyVSYS | 仮想システムを返却する | |
GetVSYSStatus | 仮想システムの状態を取得する | |
GetVSYSConfiguration | 仮想システムの構成情報を取得する | |
GetVSYSAttributes | 仮想システムの属性を取得する | |
ListNetworkInfo | 仮想システムのネットワーク情報を取得する | |
仮想サーバの操作 | CreateVServer | 仮想サーバを新規作成する |
ListVServer | 仮想システム内の仮想サーバ一覧を取得する | |
DestroyVServer | 仮想サーバを削除する | |
RestoreVServer | スナップショットから仮想サーバをリストアする | |
StartVServer | 仮想サーバを起動する | |
StopVServer | 仮想サーバを停止する | |
GetVServerStatus | 仮想サーバの状態を取得する | |
GetVServerConfiguration | 仮想サーバの構成情報(ソフトウェア、パッチなど)を取得する | |
GetVServerAttributes | 仮想サーバの属性を取得する | |
GetVServerinitialPassword | 仮想サーバのOSに対応する初期管理者パスワードをを取得する | |
UpdateVServerConfiguration | 仮想マシンの性能を変更する | |
CreateSnapshot | スナップショットを採取する | |
ListSnapshot | スナップショット一覧を取得する | |
DestroySnapshot | スナップショットを削除する | |
GetSnapshotHistory | スナップショット、リストアの履歴を取得する | |
AddPatch | パッチ情報を追加する | |
DestroyPatch | パッチ情報を削除する | |
CancelError | バックアップリストアタスクのエラー状態を解除する | |
増設ディスクの操作 | CreateVDisk | 増設ディスクを追加する |
DestroyVDisk | 増設ディスクを削除する |
CFMG APIの説明形式を説明します。
リクエストパラメーター
CFMG APIのリクエストパラメーターを表形式で説明します。
パラメーター名 | 項目 | 項目説明 |
|---|---|---|
リクエストパラメーター名(注) | 説明 | 各パラメーターの説明です。 |
型 | パラメーターの型です。 | |
設定内容 | 各パラメーターの設定内容です。固定値または実際の設定範囲の値を表現する場合には、具体的な値も説明します。 |
注)パラメーター名を[]で囲んでいる場合は、省略可能なパラメーターであることを示しています。
レスポンス
CFMG APIのレスポンスを説明します。
《ステータスコード》
ステータスコードについて説明します。
《XML》
XML形式であるレスポンスを説明します。
《要素》
要素ごとに表形式で説明します。
要素名 | 項目 | 項目説明 |
|---|---|---|
レスポンスの要素名 | 説明 | レスポンスの各要素の説明です |
型 | レスポンスの各要素の型です | |
出現回数 | レスポンスの各要素の出現回数です。要素名の親子関係によって出現回数が変化する場合についても、ここで説明しています。 |
サンプルレスポンス
CFMG APIのサンプルレスポンスを説明します。XML形式となっています。
注意
CFMG APIの出力結果は、レスポンスの説明とタグ出現の順序が異なる場合があります。
