本文へジャンプします。

ニフクラ ユーザーガイド

本ページは2023/9/5をもって、新ページhttps://docs.nifcloud.com/cp/api/CreateInstanceBackupRule.htmへ移行しました。 今後は新ページをご参照ください。

CreateInstanceBackupRule

処理概要

バックアップルールを新規作成します。

バックアップルールを作成するためには、サーバーユニークIDが必要です。
バックアップルール作成時に1つの増分バックアップが作成されます。2つ目以降の増分バックアップは「TimeSlotId」で指定した実行時間帯に作成されます。

手動で増分バックアップを作成する場合は、CreateBackupInstancesを実施することで作成できます。

2回目以降の増分バックアップの作成は、初回バックアップの作成完了後に可能となります。
「BackupInstanceMaxCount」で指定した保持する最大世代数を超えた増分バックアップが作成された場合、最も古い増分バックアップは削除されます。

指定するパラメーター

パラメーター 説明 必須
InstanceUniqueId.n string バックアップ元サーバーユニークID ※「InstanceUniqueId.1」のみ有効(複数指定不可)
BackupInstanceMaxCount integer 増分バックアップ最大世代数
使用可能文字: 1-10
TimeSlotId string 増分バックアップの実行時間帯(JST)
値:
  • 1 (0:00-1:59)
  • 2 (2:00-3:59)
  • 3 (4:00-5:59)
  • 4 (6:00-7:59)
  • 5 (8:00-9:59)
  • 6 (10:00-11:59)
  • 7 (12:00-13:59)
  • 8 (14:00-15:59)
  • 9 (16:00-17:59)
  • 10 (18:00-19:59)
  • 11 (20:00-21:59)
  • 12 (22:00-23:59)
InstanceBackupRuleName string バックアップルール名
Default: 英数8文字 (システム発行)
Description string メモ情報

応答フィールド

フィールド (項目) 説明
CreateInstanceBackupRuleResponse - CreateInstanceBackupRuleレスポンス
requestId string リクエスト識別子
return boolean 処理ステータス
値:
  • true (成功)
instanceBackupRule - バックアップルールの情報
instanceBackupRuleId string バックアップルールID
instanceBackupRuleName string バックアップルール名
instancesSet - サーバーの情報セット
item - バックアップ元のサーバーの情報
instanceId string バックアップ元のサーバー名
instanceUniqueId string バックアップ元のサーバーユニークID
backupInstancesSet string ※空を返却
バックアップサーバーの情報セット
backupInstanceMaxCount integer 増分バックアップ最大世代数
timeSlotId string 増分バックアップの実行時間帯(JST)
備考: 返却値 1 (0:00-1:59),2 (2:00-3:59),3 (4:00-5:59),4 (6:00-7:59),5 (8:00-9:59),6 (10:00-11:59),7 (12:00-13:59),8 (14:00-15:59),9 (16:00-17:59),10 (18:00-19:59),11 (20:00-21:59),12 (22:00-23:59)
status string バックアップルールのステータス
値:
  • creating (ルール作成中)
availabilityZone string バックアップ先ゾーン
regionName string バックアップ先リージョン
description string メモ情報

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/?
Action=CreateInstanceBackupRule
&BackupInstanceMaxCount=3
&Description=メモ
&InstanceBackupRuleName=backup1
&InstanceUniqueId.1=i-abcd0123
&TimeSlotId=1
&CommonParams
  

応答サンプル

    <CreateInstanceBackupRuleResponse xmlns="https://computing.api.nifcloud.com/api/">
  <requestId>1ea3f469-c3cf-4fb5-a4c7-9ff1af363af6</requestId>
  <return>true</return>
  <instanceBackupRule>
    <instanceBackupRuleId>ibr-0123abcd</instanceBackupRuleId>
    <instanceBackupRuleName>backup1</instanceBackupRuleName>
    <instancesSet>
      <item>
        <instanceId>server</instanceId>
        <instanceUniqueId>i-abcd0123</instanceUniqueId>
        <backupInstancesSet/>
      </item>
    </instancesSet>
    <backupInstanceMaxCount>3</backupInstanceMaxCount>
    <timeSlotId>1</timeSlotId>
    <status>creating</status>
    <availabilityZone>east-11</availabilityZone>
    <regionName>east-1</regionName>
    <description>メモ</description>
  </instanceBackupRule>
</CreateInstanceBackupRuleResponse>

  

ニフクラ サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2023年9月05日時点の情報です。

推奨画面サイズ 1024×768 以上