DescribeInstanceBackupRules

処理概要

バックアップルールの情報を取得します。1回のリクエストで複数のバックアップルールの情報を取得できます。

バックアップルールの情報を指定するためには、バックアップルールIDが必要です。指定しない場合は、取得可能なすべてのバックアップルールの情報を取得します。

指定するパラメーター

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

応答フィールド

フィールド (項目)	型	説明
DescribeInstanceBackupRulesResponse	DescribeInstanceBackupRulesResponseType	DescribeInstanceBackupRulesのレスポンス Ancestor: なし Children: requestId | instanceBackupRulesSet
requestId	string	リクエスト識別子 Ancestor: DescribeInstanceBackupRulesResponse Children: なし
instanceBackupRulesSet	InstanceBackupRulesSetType	バックアップルールの情報 Ancestor: DescribeInstanceBackupRulesResponse Children: item
item	InstanceBackupRulesItemType	Ancestor: instanceBackupRulesSet Children: instanceBackupRuleId | instanceBackupRuleName | instancesSet | backupInstanceMaxCount | timeSlotId | status | availabilityZone | regionName | description
instanceBackupRuleId	string	バックアップルールID Ancestor: item Children: なし
instanceBackupRuleName	string	バックアップルール名 Ancestor: item Children: なし
instancesSet	InstancesSetType	バックアップ元のサーバーの情報 Ancestor: item Children: item
item	InstancesItemType	Ancestor: instancesSet 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: item 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: item Children: なし
status	string	バックアップルールのステータス 値: creating (ルール作成中) | available(バックアップ処理可能) | wait_backup(バックアップ処理開始待ち) | backing_up(バックアップ処理中) | wait_update(ルール変更開始待ち) | updating(ルール変更中) | wait_delete(ルール削除開始待ち) | deleting(ルール削除中) | need_refresh(ルール再作成が必要) Ancestor: item Children: なし
availabilityZone	string	バックアップ先ゾーン Ancestor: item Children: なし
regionName	string	バックアップ先リージョン Ancestor: item Children: なし
description	string	メモ情報 Ancestor: item Children: なし

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/?
Action=DescribeInstanceBackupRules
&CommonParams
  

応答サンプル

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DescribeInstanceBackupRulesResponse xmlns="https://cp.cloud.nifty.com/api/3.0/">
  <requestId>ebd68c69-ae3f-4e79-839b-5029d2ef523f</requestId>
  <instanceBackupRulesSet>
    <item>
      <instanceBackupRuleId>ibr-0nzh8jch</instanceBackupRuleId>
      <instanceBackupRuleName>ActivityCheck</instanceBackupRuleName>
      <instancesSet>
        <item>
          <instanceId>MySql</instanceId>
          <instanceUniqueId>i-0gl49mh0</instanceUniqueId>
          <backupInstancesSet>
            <item>
              <backupInstanceUniqueId>bi-00000cyh</backupInstanceUniqueId>
              <status>available</status>
              <backupInstanceCreateTime>2018-11-15T21:58:39.000+09:00</backupInstanceCreateTime>
            </item>
            <item>
              <backupInstanceUniqueId>bi-0ewfh1h8</backupInstanceUniqueId>
              <status>available</status>
              <backupInstanceCreateTime>2018-11-16T07:32:38.000+09:00</backupInstanceCreateTime>
            </item>
            <item>
              <backupInstanceUniqueId>bi-0r16fth0</backupInstanceUniqueId>
              <status>available</status>
              <backupInstanceCreateTime>2018-11-16T07:33:52.000+09:00</backupInstanceCreateTime>
            </item>
            <item>
              <backupInstanceUniqueId>bi-0wr2jzk7</backupInstanceUniqueId>
              <status>available</status>
              <backupInstanceCreateTime>2018-11-16T07:34:38.000+09:00</backupInstanceCreateTime>
            </item>
            <item>
              <backupInstanceUniqueId>bi-0v3nmd4h</backupInstanceUniqueId>
              <status>available</status>
              <backupInstanceCreateTime>2018-11-16T07:35:24.000+09:00</backupInstanceCreateTime>
            </item>
            <item>
              <backupInstanceUniqueId>bi-0xej18of</backupInstanceUniqueId>
              <status>available</status>
              <backupInstanceCreateTime>2018-11-16T07:36:27.000+09:00</backupInstanceCreateTime>
            </item>
            <item>
              <backupInstanceUniqueId>bi-00000c97</backupInstanceUniqueId>
              <status>available</status>
              <backupInstanceCreateTime>2018-11-16T07:37:40.000+09:00</backupInstanceCreateTime>
            </item>
            <item>
              <backupInstanceUniqueId>bi-0ou5fhj8</backupInstanceUniqueId>
              <status>available</status>
              <backupInstanceCreateTime>2018-11-16T12:00:16.000+09:00</backupInstanceCreateTime>
            </item>
            <item>
              <backupInstanceUniqueId>bi-0wr2jzsh</backupInstanceUniqueId>
              <status>available</status>
              <backupInstanceCreateTime>2018-11-17T12:00:15.000+09:00</backupInstanceCreateTime>
            </item>
            <item>
              <backupInstanceUniqueId>bi-0v3nmdi7</backupInstanceUniqueId>
              <status>available</status>
              <backupInstanceCreateTime>2018-11-18T12:00:16.000+09:00</backupInstanceCreateTime>
            </item>
          </backupInstancesSet>
        </item>
      </instancesSet>
      <backupInstanceMaxCount>10</backupInstanceMaxCount>
      <timeSlotId>7</timeSlotId>
      <status>available</status>
      <availabilityZone>east-12</availabilityZone>
      <regionName>east-1</regionName>
      <description>メモ</description>
    </item>
  </instanceBackupRulesSet>
</DescribeInstanceBackupRulesResponse>