本文へジャンプします。

ニフクラ ユーザーガイド

CreateBackupInstances

処理概要

バックアップルールに設定されているサーバーの、増分バックアップを作成します。

増分バックアップを作成するためには、バックアップルールIDが必要です。処理中のバックアップルールIDを指定した、管理外のバックアップルールIDを指定したなど、無効なバックアップルールIDを指定した場合は、エラーが返されます。

指定するパラメーター

パラメーター 説明 必須
InstanceBackupRuleId string バックアップルールID

応答フィールド

フィールド (項目) 説明
CreateBackupInstancesResponse CreateBackupInstancesResponseType CreateBackupInstancesのレスポンス
Ancestor: なし
Children: requestId | return | instanceBackupRule
requestId string リクエスト識別子
Ancestor: CreateBackupInstancesResponse
Children: なし
return boolean 処理結果
Ancestor: CreateBackupInstancesResponse
Children: なし
instanceBackupRule InstanceBackupRuleType バックアップルールの情報
Ancestor: CreateBackupInstancesResponse
Children: instanceBackupRuleId | instanceBackupRuleName | instancesSet | backupInstanceMaxCount | timeSlotId | status | availabilityZone | regionName | description
instanceBackupRuleId string バックアップルールID
Ancestor: instanceBackupRule
Children: なし
instanceBackupRuleName string バックアップルール名
Ancestor: instanceBackupRule
Children: なし
instancesSet InstancesSetType サーバーの情報セット
Ancestor: instanceBackupRule
Children: item
item InstanceBackupRuleItemType バックアップ元のサーバーの情報
Ancestor: instanceBackupRule
Children: instanceId | instanceUniqueId | backupInstancesSet
instanceId string バックアップ元のサーバー名
Ancestor: item
Children: なし
instanceUniqueId string バックアップ元のサーバーユニークID
Ancestor: item
Children: なし
backupInstancesSet BackupInstancesSetType バックアップサーバーセット
Ancestor: item
Children: item
item BackupInstancesItemType
Ancestor: backupInstancesSet
Children: backupInstanceUniqueId | status | backupInstanceCreateTime
backupInstanceUniqueId string バックアップサーバーユニークID
Ancestor: item
Children: なし
status string バックアップサーバーのステータス
値: wait_backup(バックアップ開始待ち) | backing_up(バックアップ中) | available(処理可能) | wait_copy(バックアップサーバーのコピー開始待ち) | copying(コピー中) | wait_delete(バックアップサーバーの削除開始待ち) | deleting(バックアップサーバー削除中)
Ancestor: item
Children: なし
backupInstanceCreateTime string バックアップサーバー作成日時
Ancestor: item
Children: なし
backupInstanceMaxCount integer 増分バックアップ最大世代数
Ancestor: instanceBackupRule
Children: なし
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)
Ancestor: instanceBackupRule
Children: なし
status string バックアップルールのステータス
値: creating (ルール作成中) | available(バックアップ処理可能) | wait_backup(バックアップ処理開始待ち) | backing_up(バックアップ処理中) | wait_update(ルール変更開始待ち) | updating(ルール変更中) | wait_delete(ルール削除開始待ち) | deleting(ルール削除中)
Ancestor: instanceBackupRule
Children: なし
availabilityZone string バックアップ先ゾーン
Ancestor: instanceBackupRule
Children: なし
regionName string バックアップ先リージョン
Ancestor: instanceBackupRule
Children: なし
description string メモ情報
Ancestor: instanceBackupRule
Children: なし

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/?
Action=CreateBackupInstances
&InstanceBackupRuleId=ibr-0123abcd
&CommonParams
  

応答サンプル

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CreateBackupInstancesResponse xmlns="https://cp.cloud.nifty.com/api/3.0/">
  <requestId>84cbfe0b-c94a-4a3d-a6cb-1957a1bc0756</requestId>
  <return>true</return>
  <instanceBackupRule>
    <instanceBackupRuleId>ibr-0123abcd</instanceBackupRuleId>
    <instanceBackupRuleName>backup</instanceBackupRuleName>
    <instancesSet>
      <item>
        <instanceId>4210e2de</instanceId>
        <instanceUniqueId>i-0gl439y1</instanceUniqueId>
        <backupInstancesSet>
          <item>
            <backupInstanceUniqueId>bi-05qch410</backupInstanceUniqueId>
            <status>available</status>
            <backupInstanceCreateTime>2018-11-19T12:32:59.000+09:00</backupInstanceCreateTime>
          </item>
          <item>
            <backupInstanceUniqueId>bi-0xej18f8</backupInstanceUniqueId>
            <status>available</status>
            <backupInstanceCreateTime>2018-11-19T18:43:07.000+09:00</backupInstanceCreateTime>
          </item>
          <item>
            <backupInstanceUniqueId>bi-00000ct1</backupInstanceUniqueId>
            <status>wait_backup</status>
            <backupInstanceCreateTime/>
          </item>
        </backupInstancesSet>
      </item>
    </instancesSet>
    <backupInstanceMaxCount>1</backupInstanceMaxCount>
    <timeSlotId>1</timeSlotId>
    <status>wait_backup</status>
    <availabilityZone>east-11</availabilityZone>
    <regionName>east-1</regionName>
    <description>メモ</description>
  </instanceBackupRule>
</CreateBackupInstancesResponse>

  

ニフティクラウド サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ

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