すべてのプロダクト
Search

このプロダクト

    Resource Orchestration Service:ALIYUN::HBR::DbPlan

    ドキュメントセンター

    Resource Orchestration Service:ALIYUN::HBR::DbPlan

    最終更新日:Jun 17, 2026

    データベースバックアップ計画を作成します。

    構文

    {
  "Type": "ALIYUN::HBR::DbPlan",
  "Properties": {
    "Options": String,
    "InstanceUuid": String,
    "SourceType": String,
    "VaultId": String,
    "Source": Map,
    "ContinuousPlan": String,
    "IncPlan": String,
    "MaxRetrySeconds": Integer,
    "HostUuid": String,
    "CumulativePlan": String,
    "FullPlan": String,
    "LogPlan": String,
    "MaxRateLimit": Integer,
    "DbPlanName": String
  }
}

    プロパティ

    プロパティ タイプ 必須 更新の許可 説明 制約
    Options String いいえ いいえ バックアップオプション。 値は SourceType に応じて異なる JSON 文字列です。
    • SourceType が ORACLE の場合、値の例は {"channels":4,"compression":"lzop","offline_backup":false,"archivelog_reserve_hours":24,"custom_commands":""} です。
      • channels： 同時ジョブの数。
      • archivelog_reserve_hours： バックアップ完了後にアーカイブログを保持する時間 (時間単位)。
      • 他のパラメーターにはデフォルト値を使用します。
      説明 Oracle のバックアップに関する詳細については、「Oracle データベースのバックアップ」をご参照ください。
    • SourceType が MySQL の場合、値の例は {"channels":4,"compression":"lzop","del_binlog":false} です。

      del_binlog は、バックアップ後にバイナリログ (binlog) を削除するかどうかを指定します。ログバックアップまたはリアルタイムバックアップにのみ有効です。

      説明 MySQL のバックアップに関する詳細については、「MySQL データベースのバックアップ」をご参照ください。
    • SourceType が MSSQL の場合、値の例は {\"channels\":4,\"verify\":false,\"compression\":\"lzop\",\"backup_new_databases\":false} です。
      説明 MSSQL のバックアップに関する詳細については、「SQL Server データベースのバックアップ」をご参照ください。
    InstanceUuid String いいえ いいえ データベースインスタンスの UUID。 なし
    SourceType String はい はい ソースタイプ。 有効な値：
    • MYSQL
    • ORACLE
    • MSSQL
    VaultId String はい いいえ リポジトリ ID。 なし
    Source Map いいえ いいえ バックアップソース。 詳細については、「ソース構文」と「ソースプロパティ」をご参照ください。
    ContinuousPlan String いいえ はい 継続的ログバックアップのスケジュール。 値：{"type": "continuous"}。
    IncPlan String いいえ はい 増分バックアップのスケジュール。

    このパラメーターは、MySQL および ORACLE データソースにのみ有効です。

    値は JSON 文字列です。例：
    • 日次定期バックアップの場合：{"type": "daily", "start": "00:00:00", "interval": 3}
    • 週次定期バックアップの場合：{"type":"weekly","start": "03:00:00","days": [1,2,3,4,5],"interval": 1}
    説明
    • days は曜日を指定します。有効な値は 0～6 です。0 は日曜日を示します。
    • interval は間隔を指定します。有効な値は 1～52 です。
    MaxRetrySeconds Integer いいえ はい 再接続タイムアウト期間。 バックアップ中の切断後、データベースに再接続するまでの待機時間 (秒)。デフォルト値： 600。
    HostUuid String はい いいえ クライアントホストの UUID。 なし
    CumulativePlan String いいえ はい 累積増分バックアップのスケジュール。

    このパラメーターは、MSSQL データソースにのみ有効です。

    値は JSON 文字列です。例：
    • 日次定期バックアップの場合：{"type": "daily", "start": "00:00:00", "interval": 3}
    • 週次定期バックアップの場合：{"type":"weekly","start": "03:00:00","days": [1,2,3,4,5],"interval": 1}
    説明
    • days は曜日を指定します。有効な値は 0～6 です。0 は日曜日を示します。
    • interval は間隔を指定します。有効な値は 1～52 です。
    FullPlan String いいえ はい 完全バックアップのスケジュール。 値は JSON 文字列です。例：
    • 日次定期バックアップの場合：{"type": "daily", "start": "00:00:00", "interval": 3}
    • 週次定期バックアップの場合：{"type":"weekly","start": "03:00:00","days": [1,2,3,4,5],"interval": 1}
    説明
    • days は曜日を指定します。有効な値は 0～6 です。0 は日曜日を示します。
    • interval は間隔を指定します。有効な値は 1～52 です。
    LogPlan String いいえ はい ログバックアップのスケジュール。 値は JSON 文字列です。例：
    • 日次定期バックアップの場合：{"type": "daily", "start": "00:00:00", "interval": 3}
    • 週次定期バックアップの場合：{"type":"weekly","start": "03:00:00","days": [1,2,3,4,5],"interval": 1}
    説明
    • days は曜日を指定します。有効な値は 0～6 です。0 は日曜日を示します。
    • interval は間隔を指定します。有効な値は 1～52 です。
    MaxRateLimit Integer いいえ はい 速度制限。 デフォルト値は 0 で、速度制限がないことを示します。
    DbPlanName String はい はい バックアップ計画の名前。 なし

    ソース構文

    "Source": {
  "Entries": List
}

    ソースプロパティ

    プロパティ タイプ 必須 更新の許可 説明 制約
    Entries List いいえ いいえ バックアップソース。 有効な値：
    • SourceType が ORACLE の場合：["oracle://${instanceName}", "oracle://${instanceName}/archivelog"]。

      ${instanceName} は Oracle データベースインスタンスの名前で、dbAgent (ORACLE) リソースから取得できます。

    • SourceType が MySQL の場合：["mysql://${instanceName}"]。

      ${instanceName} は MySQL データベースインスタンスの名前です。この名前は dbAgent (MySQL) リソースから取得できます。

    • SourceType が MSSQL の場合：["mssql://${instanceName}/${database1}", "mssql://${instanceName}/${database2}"]。

      ${database} は dbAgent (MSSQL) リソースから取得できます。

    戻り値

    Fn::GetAtt

    • Options： JSON 形式のバックアップオプション。
    • InstanceUuid： データベースインスタンスの UUID。
    • CumulativeUuid： 累積計画の UUID。
    • SourceType： ソースタイプ。
    • PlanId： バックアップ計画の ID。
    • LogUuid： ログバックアップ計画の UUID。
    • VaultId： リポジトリ ID。
    • IncUuid： 増分バックアップ計画の UUID。
    • ContinuousPlan： 継続的ログバックアップのスケジュール。
    • IncPlan： 増分バックアップのスケジュール。
    • MaxRetrySeconds： 再接続タイムアウト期間。
    • Target： バックアップ先のリポジトリ。
    • HostUuid： クライアントホストの UUID。
    • ContinuousUuid： 継続的ログバックアップ計画の UUID。
    • CumulativePlan： 累積増分バックアップのスケジュール。
    • FullPlan： 完全バックアップのスケジュール。
    • LogPlan： ログバックアップのスケジュール。
    • MaxRateLimit： 速度制限。
    • FullUuid： 完全バックアップ計画の UUID。
    • DbPlanName： バックアップ計画の名前。

    例

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Options": {
      "Type": "String",
      "Description": "JSON 形式のバックアップオプション。値はデータベースタイプごとに異なります。Oracle の場合、 {\"channels\":4,\"compression\":\"lzop\",\"offline_backup\":false,\"archivelog_reserve_hours\":24,\"custom_commands\":\"\"} を使用します。channels パラメーターは同時スレッド数を指定します。archivelog_reserve_hours パラメーターは、バックアップジョブの完了後にアーカイブログが削除されるまでの時間を時間単位で指定します。他のパラメーターにはデフォルト値を使用します。MySQL の場合、 {\"channels\":4,\"compression\":\"lzop\",\"del_binlog\":false} を使用します。del_binlog パラメーターは、バックアップ完了後にバイナリログ (binlog) を削除するかどうかを指定します。このパラメーターは、ログバックアップまたはリアルタイムバックアップにのみ有効です。SQL Server の場合、 {\"channels\":4,\"verify\":false,\"compression\":\"lzop\",\"backup_new_databases\":false} を使用します。",
      "Default": "{\"channels\":4,\"compression\":\"lzop\",\"del_binlog\":false}"
    },
    "InstanceUuid": {
      "Type": "String",
      "Description": "データベースインスタンスの UUID。",
      "Default": "d12729b82116154****"
    },
    "SourceType": {
      "Type": "String",
      "Description": "データベースタイプ。有効な値：MYSQL、ORACLE、MSSQL。",
      "Default": "MYSQL"
    },
    "VaultId": {
      "Type": "String",
      "Description": "バックアップ計画を作成するバックアップリポジトリの ID。バックアップデータはリポジトリに保存されます。",
      "Default": "v-df****"
    },
    "Source": {
      "Type": "Json",
      "Description": "バックアップするデータベースインスタンスまたはデータベース。",
      "Default": "{\n  \"Entries\": [\n    \"mysql://MYSQL-3306\"\n  ]\n}"
    },
    "ContinuousPlan": {
      "Type": "String",
      "Description": "継続的なバックアップスケジュール。{ \"type\": \"continuous\" } を使用します。",
      "Default": "{\"type\":\"continuous\"}"
    },
    "IncPlan": {
      "Type": "String",
      "Description": "増分バックアップのスケジュール。このパラメーターは MySQL と Oracle にのみ有効です。詳細については、「FullPlan」をご参照ください。",
      "Default": "{\n    \"interval\": 1,\n    \"start\": \"00:00:00\",\n    \"type\": \"daily\"\n  }"
    },
    "MaxRetrySeconds": {
      "Type": "Number",
      "Description": "ネットワーク障害発生時の最大再試行秒数。",
      "Default": "600"
    },
    "HostUuid": {
      "Type": "String",
      "Description": "データベースインスタンスが存在するホストの UUID。",
      "Default": "701781640b3afc****"
    },
    "FullPlan": {
      "Type": "String",
      "Description": "完全バックアップのスケジュール。日次バックアップの場合は、{\"type\": \"daily\", \"start\": \"00:00:00\", \"interval\": 3} を使用します。週次バックアップの場合は、{\"type\":\"weekly\",\"start\": \"03:00:00\",\"days\": [1,2,3,4,5],\"interval\": 1} を使用します。days パラメーターは 0～6 で指定でき、0 は日曜日を示します。interval は 1～52 で指定できます。",
      "Default": "{\n    \"days\": [\n      6\n    ],\n    \"interval\": 1,\n    \"start\": \"18:00:00\",\n    \"type\": \"weekly\"\n  }"
    },
    "DbPlanName": {
      "Type": "String",
      "Description": "バックアップ計画の表示名。",
      "Default": "test"
    }
  },
  "Resources": {
    "HBRDbPlan": {
      "Type": "ALIYUN::HBR::DbPlan",
      "Properties": {
        "Options": {
          "Ref": "Options"
        },
        "InstanceUuid": {
          "Ref": "InstanceUuid"
        },
        "SourceType": {
          "Ref": "SourceType"
        },
        "VaultId": {
          "Ref": "VaultId"
        },
        "Source": {
          "Ref": "Source"
        },
        "ContinuousPlan": {
          "Ref": "ContinuousPlan"
        },
        "IncPlan": {
          "Ref": "IncPlan"
        },
        "MaxRetrySeconds": {
          "Ref": "MaxRetrySeconds"
        },
        "HostUuid": {
          "Ref": "HostUuid"
        },
        "FullPlan": {
          "Ref": "FullPlan"
        },
        "DbPlanName": {
          "Ref": "DbPlanName"
        }
      }
    }
  },
  "Outputs": {
    "Options": {
      "Description": "JSON 形式のバックアップオプション。値はデータベースタイプごとに異なります。Oracle の場合、 {\"channels\":4,\"compression\":\"lzop\",\"offline_backup\":false,\"archivelog_reserve_hours\":24,\"custom_commands\":\"\"} を使用します。channels パラメーターは同時スレッド数を指定します。archivelog_reserve_hours パラメーターは、バックアップジョブの完了後にアーカイブログが削除されるまでの時間を時間単位で指定します。他のパラメーターにはデフォルト値を使用します。MySQL の場合、 {\"channels\":4,\"compression\":\"lzop\",\"del_binlog\":false} を使用します。del_binlog パラメーターは、バックアップ完了後にバイナリログ (binlog) を削除するかどうかを指定します。このパラメーターは、ログバックアップまたはリアルタイムバックアップにのみ有効です。SQL Server の場合、 {\"channels\":4,\"verify\":false,\"compression\":\"lzop\",\"backup_new_databases\":false} を使用します。",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "Options"
        ]
      }
    },
    "InstanceUuid": {
      "Description": "データベースインスタンスの UUID。",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "InstanceUuid"
        ]
      }
    },
    "CumulativeUuid": {
      "Description": "累積計画の UUID。",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "CumulativeUuid"
        ]
      }
    },
    "SourceType": {
      "Description": "データベースタイプ。有効な値：MYSQL、ORACLE、MSSQL。",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "SourceType"
        ]
      }
    },
    "PlanId": {
      "Description": "バックアップ計画の ID。",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "PlanId"
        ]
      }
    },
    "LogUuid": {
      "Description": "ログバックアップ計画の UUID。",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "LogUuid"
        ]
      }
    },
    "VaultId": {
      "Description": "バックアップ計画を作成するバックアップリポジトリの ID。バックアップデータはリポジトリに保存されます。",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "VaultId"
        ]
      }
    },
    "IncUuid": {
      "Description": "増分バックアップ計画の UUID。",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "IncUuid"
        ]
      }
    },
    "ContinuousPlan": {
      "Description": "継続的なバックアップスケジュール。{ \"type\": \"continuous\" } を使用します。",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "ContinuousPlan"
        ]
      }
    },
    "IncPlan": {
      "Description": "増分バックアップのスケジュール。このパラメーターは MySQL と Oracle にのみ有効です。詳細については、「FullPlan」をご参照ください。",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "IncPlan"
        ]
      }
    },
    "MaxRetrySeconds": {
      "Description": "ネットワーク障害発生時の最大再試行秒数。",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "MaxRetrySeconds"
        ]
      }
    },
    "Target": {
      "Description": "バックアップ先のリポジトリ。",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "Target"
        ]
      }
    },
    "HostUuid": {
      "Description": "データベースインスタンスが存在するホストの UUID。",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "HostUuid"
        ]
      }
    },
    "ContinuousUuid": {
      "Description": "継続的なバックアップ計画の UUID。",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "ContinuousUuid"
        ]
      }
    },
    "CumulativePlan": {
      "Description": "累積増分バックアップのスケジュール。このパラメーターは MSSQL にのみ有効です。詳細については、「FullPlan」をご参照ください。",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "CumulativePlan"
        ]
      }
    },
    "FullPlan": {
      "Description": "完全バックアップのスケジュール。日次バックアップの場合は、{\"type\": \"daily\", \"start\": \"00:00:00\", \"interval\": 3} を使用します。週次バックアップの場合は、{\"type\":\"weekly\",\"start\": \"03:00:00\",\"days\": [1,2,3,4,5],\"interval\": 1} を使用します。days パラメーターは 0～6 で指定でき、0 は日曜日を示します。interval は 1～52 で指定できます。",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "FullPlan"
        ]
      }
    },
    "LogPlan": {
      "Description": "ログバックアップのスケジュール。詳細については、「FullPlan」をご参照ください。",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "LogPlan"
        ]
      }
    },
    "MaxRateLimit": {
      "Description": "バックアップジョブの最大レート制限。",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "MaxRateLimit"
        ]
      }
    },
    "FullUuid": {
      "Description": "完全バックアップ計画の UUID。",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "FullUuid"
        ]
      }
    },
    "DbPlanName": {
      "Description": "バックアップ計画の表示名。",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "DbPlanName"
        ]
      }
    }
  }
}