オンラインバックアップ

API情報
API種別メソッドURI対象名称実行
設定PUT/:GisServiceCode/system-storages/:StorageServiceCode/backup.jsonシステムストレージオンラインバックアップ非同期
  • 指定したシステムストレージタイプXのバックアップを取得します
  • このAPIはシステムストレージタイプXでのみ実行できます。システムストレージタイプSでは実行できません
  • このAPIを利用するにはストレージアーカイブの契約が必要です
  • APIのレスポンスはバックアップの取得が終わるのを待つことなく戻ります
  • バックアップ中はシステムストレージタイプXのModeがBackupとなり、完了するとBasicに戻ります
  • 作成中のイメージステータスはCreatingとなり、完了するとCreatedとなります
  • 仮想サーバが起動中でもバックアップすることが可能です
  • インスタントクローニングのクローン元もしくはクローン先となっているシステムストレージのオンラインバックアップはできません


リクエストパラメータ

パラメータ必須意味
URLGisServiceCode操作対象が所属するgisのサービスコードgis########

ServiceCode操作対象となるストレージのサービスコードica########
ボディLabelラベル文字列
レスポンス
フィールドタイプ意味
Current.ResourceStatusString設定後のストレージステータス
Previous.ResourceStatusString設定前のストレージステータス
エラーコード
  • このAPIに関する個別エラーはありません。
  • 共通エラーコードはエラーレスポンスを参照して下さい


制限
  • 特になし


サンプル

リクエストボディ

{
    "Label": "ラベルサンプル"
}

レスポンス (JSON)

{
    "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
    "Current": {
        "ResourceStatus": "PreparingBackup"
    },
    "Previous": {
        "ResourceStatus": "Attached"
    }
}