GMOクラウド Public APIリファレンス

サポートトップ » GMOクラウド Public トップ » APIリファレンス

listBackups

機能の処理概要

仮想サーバーのバックアップ一覧の取得

仮想サーバーのバックアップ一覧を返します。バックアップが存在しない場合、空の配列を返します。
指定した仮想サーバーのIDが無効であるか、あるいは存在しない場合は、エラーを返します。

リクエストパラメーター

この機能の実行時には以下のパラメーターを指定してください。

パラメーター 説明 必須
Identifier VM識別子

仮想サーバーの識別子を指定します
仮想サーバーの識別子は4.1. listNodes APIで取得できます
4.1. listNodesのレスポンスオブジェクトのうち、identifier が該当します

レスポンスオブジェクト

以下の形式で応答します。

フィールド 説明
allow_resize_without_reboot 仮想サーバーのバックアップを再起動せずにCPUとメモリのサイズ変更ができるか否かを返します

true : 再起動せずにサイズ変更可能
false : 上記以外の状態
allowed_hot_migrate 仮想サーバーのバックアップがホットマイグレーションをすることができるか否かを返します

true : ホットマイグレーションが可能
false : 上記以外の状態
allowed_swap 仮想サーバーのバックアップでスワップディスクの使用ができるか否かを返します

true : スワップディスクの使用が可能
false : 上記以外の状態
backup_size 当該バックアップで使用しているディスク容量を返します

単位は MB (MegaBytes)です
backup_type 当該バックアップのバックアップタイプを返します
built 当該バックアップのビルド状態を返します

true : ビルド済みの状態
false : 上記以外の状態
built_at 当該バックアップが完了した日時を返します
日時は下記のフォーマットで表されます

YYYY-MM-DDThh:mm:ssZ
created_at 当該バックアップがビルド済みもしくは実行待ちになった日時を返します
日時は下記のフォーマットで表されます

YYYY-MM-DDThh:mm:ssZ
disk_id 当該バックアップの対象のディスクのIDを返します
id 当該バックアップのIDを返します
identifier 当該バックアップの識別子を返します
locked 当該仮想サーバーのバックアップのロック状態を返します

true : バックアップがロックされている状態
false : 上記以外の状態
min_disk_size 最少のディスクサイズを返します
operating_system 当該仮想サーバーのバックアップが仮想サーバー構築時に使用したOSの種類を返します
operating_system_distro 当該仮想サーバーのバックアップが仮想サーバー構築時に使用したOSのディストリビューションの種類を返します
template_id 当該仮想サーバーのバックアップが仮想サーバー構築時に指定したテンプレートのIDを返します
updated_at 当該バックアップが最後にアップデートされた日時を返します
日時は下記のフォーマットで表されます

YYYY-MM-DDThh:mm:ssZ

リクエストサンプル

https://api.gmocloud.com/Cloud-Zone-ID/?Action=listBackups&AccessKeyId=AccessKeyId&Version=1.0&Identifier=Identifier_of_VM&Signature=Signature

レスポンスサンプル

{
  "Id_of_Backups": {
    "built_at": "2012-07-19T12:37:49+09:00",
    "disk_id": Id_of_Disk,
    "marked_for_delete": false,
    "created_at": "2012-07-19T12:35:48+09:00",
    "operating_system_distro": "rhel",
    "min_memory_size": 128,
    "operating_system": "linux",
    "template_id": 9,
    "allowed_swap": true,
    "backup_type": "normal",
    "updated_at": "2012-07-19T12:37:50+09:00",
    "allow_resize_without_reboot": true,
    "id": Id_of_Backups,
    "allowed_hot_migrate": true,
    "backup_server_id": null,
    "backup_size": "210520",
    "identifier": "Identifier_of_Backups",
    "min_disk_size": 5,
    "built": true,
    "locked": false
  }
}

このガイドで問題は解決しましたか?

ご回答ありがとうございました。

引き続きGMOクラウド サポートサイトをご利用ください。

ご回答ありがとうございました。

GMOクラウド Public サポートまでお問い合わせください。

お問い合わせ