L-Platform APIは、以下のAPIから構成されています。
分類 | L-Platform API名 | 機能概要 |
|---|---|---|
L-Platformテンプレートの操作 | ListLPlatformDescriptor | テンプレート一覧を取得する |
ListDiskImage | マスターイメージの一覧を取得する | |
ListServerType | L-Serverテンプレート一覧を取得する | |
GetLPlatformDescriptorConfiguration | テンプレートの構成情報(サーバ構成、ネットワーク構成など)を取得する | |
GetLPlatformDescriptorAttributes | テンプレートの属性(テンプレート名など)を取得する | |
GetPoolList | リソースプールの一覧を取得する | |
ListNetworkResource | ネットワークリソースの一覧を取得する | |
L-Platform操作 | CreateLPlatform | L-Platformを作成する |
ListLPlatform | L-Platformの一覧を取得する | |
MoveLPlatform | L-Platformの所有組織を変更する | |
DestroyLPlatform | L-Platformを返却する | |
GetLPlatformStatus | L-Platformの状態を取得する | |
GetLPlatformConfiguration | L-Platformの構成情報を取得する | |
GetLPLatformAttributes | L-Platformの属性を取得する | |
ListNetworkInfo | L-Platformのネットワーク一覧を取得する | |
StartLPlatform | L-Platformに含まれるサーバを一括電源ONする | |
StopLPlatform | L-Platformに含まれるサーバを一括電源OFFする | |
StartTenantLServers | テナントに含まれるすべてのサーバを一括電源ONする | |
StopTenantLServers | テナントに含まれるすべてのサーバを一括電源OFFする | |
CreateNetwork | L-Platformにネットワークセグメントを追加する | |
DestroyNetwork | 指定したネットワークセグメントをL-Platformから削除する | |
サーバの操作 | CreateLServer | サーバを新規作成する |
ListLServer | L-Platform内のサーバ一覧を取得する | |
DestroyLServer | サーバを削除する | |
RestoreLServer | スナップショットからサーバをリストアする | |
StartLServer | サーバを起動する | |
StopLServer | サーバを停止する | |
GetLServerStatus | サーバの状態を取得する | |
GetLServerConfiguration | サーバの構成情報(ソフトウェア、パッチなど)を取得する | |
GetLServerAttributes | サーバの属性を取得する | |
GetLServerInitialPassword | サーバのOSに対応する初期管理者パスワードを取得する | |
UpdateLServerConfiguration | サーバの性能を変更する | |
CreateImage | 指定したサーバのクローニングイメージを採取する | |
CreateSnapshot | スナップショットを採取する | |
ListSnapshot | スナップショット一覧を取得する | |
DestroySnapshot | スナップショットを削除する | |
GetSnapshotHistory | スナップショット、リストアの履歴を取得する | |
AddPatch | パッチ情報を追加する | |
DestroyPatch | パッチ情報を削除する | |
CancelError | バックアップリストアタスクのエラー状態を解除する | |
CreateNic | サーバにNICを追加する | |
DestroyNic | 指定したNICをサーバから削除する | |
増設ディスクの操作 | CreateDisk | 増設ディスクを追加する |
DestroyDisk | 増設ディスクを削除する | |
ListDisk | 既存ディスクの一覧を取得する | |
AttachDisk | 拡張ディスクを取り付ける | |
DetachDisk | 拡張ディスクを取り外す |
L-Platform APIの説明形式を説明します。
リクエストパラメーター
L-Platform APIのリクエストパラメーターを表形式で説明します。
パラメーター名 | 項目 | 項目説明 |
|---|---|---|
リクエストパラメーター名(注) | 説明 | 各パラメーターの説明です。 |
型 | パラメーターの型です。 | |
設定内容 | 各パラメーターの設定内容です。固定値または実際の設定範囲の値を表現する場合には、具体的な値も説明します。 |
注)パラメーター名を[]で囲んでいる場合は、省略可能なパラメーターであることを示しています。
コマンド
コマンドの形式を説明します。
パラメーター名を[]で囲んでいる場合は、省略可能なパラメーターであることを示しています。
パラメーターの詳細については、各APIの「リクエストパラメーター」を参照してください。
レスポンス
L-Platform APIのレスポンスを説明します。
《ステータスコード》
ステータスコードについて説明します。
《XML》
XML形式であるレスポンスを説明します。
《要素》
要素ごとに表形式で説明します。
要素名 | 項目 | 項目説明 |
|---|---|---|
レスポンスの要素名 | 説明 | レスポンスの各要素の説明です |
型 | レスポンスの各要素の型です | |
出現回数 | レスポンスの各要素の出現回数です。要素名の親子関係によって出現回数が変化する場合についても、ここで説明しています。 |
サンプルレスポンス
L-Platform APIのサンプルレスポンスを説明します。XML形式となっています。
注意
L-Platform APIの出力結果は、レスポンスの説明とタグ出現の順序が異なる場合があります。
