すべてのプロダクト
Search
ドキュメントセンター

Resource Orchestration Service:ALIYUN::HBR::DbPlan

最終更新日:Mar 17, 2025

ALIYUN::HBR::DbPlanは、バックアップ計画の作成に使用されます。

構文

{
  "タイプ": "ALIYUN::HBR::DbPlan" 、
  "Properties": {
    "オプション": 文字列、
    "InstanceUuid": 文字列、
    "SourceType": 文字列、
    "VaultId": 文字列、
    "ソース": 地図、
    "ContinuousPlan": ストリング、
    "IncPlan": 文字列、
    "MaxRetrySeconds": 整数、
    "HostUuid": 文字列、
    "CumulativePlan": 文字列、
    "FullPlan": ストリング、
    "LogPlan": 文字列、
    "MaxRateLimit": 整数、
    "DbPlanName": 文字列
  }
}

プロパティ

プロパティデータ型必須編集可能説明制約条件
オプションString任意不可バックアップオプション。 値はJSON文字列で、SourceType値によって異なります。 サンプル値:
  • 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: バックアップ完了後にバイナリログを削除するかどうかを示します。 このパラメーターは、ログバックアップとリアルタイムバックアップに対してのみ有効です。

    説明 MySQLデータベースをバックアップする方法の詳細については、「MySQLデータベースのバックアップ」をご参照ください。
  • SourceTypeをMSSQLに設定した場合のサンプル値: {\"channels\":4,\"verify\":false,\"compression\":\"lzop\",\"backup_new_databases\":false}
    説明 SQL Serverデータベースのバックアップ方法の詳細については、「SQL Serverデータベースのバックアップ」をご参照ください。
InstanceUuidString任意不可データベースインスタンスのUUID。 なし。
SourceTypeString必須移行元ディスクのタイプを設定します。 有効な値:
  • MYSQL
  • オラクル
  • MSSQL
VaultIdString必須不可バックアップコンテナーのID。 なし。
ソース地図不可不可バックアップするデータベースインスタンス。 詳細については、「ソース構文」および「ソースプロパティ」をご参照ください。
ContinuousPlanString継続しない継続するログの継続的なバックアップ計画。 値を {"type": "continuous"} に設定します。
IncPlanString継続しない継続する増分バックアップ計画。

このパラメータは、ソース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}: データベースを毎週バックアップする場合、値が使用されます。
説明
  • 日: 特定の日。 日の有効値: 0〜6。 0は日曜日を示します。
  • interval: 連続したバックアップ計画の間隔。 間隔の有効値: 1〜52。
MaxRetrySecondsInteger継続しない継続するデータベースが切断された後にデータベースに再接続するまでの時間 バックアップ中。 既定値:600。 単位は秒です。
HostUuidString必須不可クライアントのUUID。 なし。
CumulativePlanString継続しない継続する累積増分バックアッププラン。

このパラメーターは、ソースSQL Serverデータベースにのみ適用できます。

値はJSON文字列です。 サンプル値:
  • {"type": "daily", "start": "00:00:00", "interval": 3},: データベースを毎日バックアップする場合、値が使用されます。
  • {"type": "weekly","start": "03:00:00","days": [1,2,3,4,5],"interval": 1}: データベースを毎週バックアップする場合、値が使用されます。
説明
  • 日: 特定の日。 日の有効値: 0〜6。 0は日曜日を示します。
  • interval: 連続したバックアップ計画の間隔。 間隔の有効値: 1〜52。
FullPlanString継続しない継続する完全バックアップ計画。 値はJSON文字列です。 サンプル値:
  • {"type": "daily", "start": "00:00:00", "interval": 3},: データベースを毎日バックアップする場合、値が使用されます。
  • {"type": "weekly","start": "03:00:00","days": [1,2,3,4,5],"interval": 1}: データベースを毎週バックアップする場合、値が使用されます。
説明
  • 日: 特定の日。 日の有効値: 0〜6。 0は日曜日を示します。
  • interval: 連続したバックアップ計画の間隔。 間隔の有効値: 1〜52。
LogPlanString継続しない継続するログのバックアップ計画。 値はJSON文字列です。 サンプル値:
  • {"type": "daily", "start": "00:00:00", "interval": 3},: データベースを毎日バックアップする場合、値が使用されます。
  • {"type": "weekly","start": "03:00:00","days": [1,2,3,4,5],"interval": 1}: データベースを毎週バックアップする場合、値が使用されます。
説明
  • 日: 特定の日。 日の有効値: 0〜6。 0は日曜日を示します。
  • interval: 連続したバックアップ計画の間隔。 間隔の有効値: 1〜52。
MaxRateLimitInteger継続しない継続するバックアップ速度の最大値。 デフォルト値:0 0は、バックアップ速度が制限されていないことを示します。
DbPlanNameString必須バックアップ計画の名前。 なし。

ソース構文

"ソース": {
  "エントリ": リスト
} 

ソースのプロパティ

プロパティデータ型必須編集可能説明制約条件
EntriesList不可不可ソースデータベースインスタンス。 有効な値:
  • SourceTypeをORACLEに設定した場合の有効値: ["oracle://${instanceName}", "oracle://${instanceName}/archivelog"]

    ${instanceName}: Oracleデータベース・インスタンスの名前。 ALIYUN::HBR::DbAgentリソースタイプを指定して名前を取得できます。

  • SourceTypeをMYSQLに設定した場合の有効値: ["mysql://${instanceName}"]

    ${instanceName}: MySQLデータベースインスタンスの名前。 ALIYUN::HBR::DbAgentリソースタイプを指定して名前を取得できます。

  • SourceTypeをMSSQLに設定した場合の有効値: ["mssql://${instanceName}/${databse1}", "mssql://${instanceName}/${databse2}"]

    ${database}: SQL Serverデータベースの名前。 ALIYUN::HBR::DbAgentリソースタイプを指定して名前を取得できます。

レスポンスパラメーター

Fn::GetAtt

  • オプション: バックアップオプション。 値はJSON形式です。
  • InstanceId: データベースインスタンスのID。
  • CumulativeUuid: 増分バックアッププランのID。
  • SourceType: ソースデータベースのタイプ。
  • PlanId: バックアッププランのID。
  • LogUuid: ログのID。
  • VaultId: バックアップコンテナーのID。
  • IncUuid: 増分バックアッププランのID。
  • ContinuousPlan: ログの継続バックアップ計画。
  • IncPlan: 増分バックアップ計画。
  • MaxRetrySeconds: データベースが切断された後、データベースに再接続するために消費される時間。
  • ターゲット: バックアップされるデータベース。
  • 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" 、
      "デフォルト": "d12729b82116154 ****"
    },
    "SourceType": {
      "Type": "String",
      "Description": "データベースタイプ、許可された値: MySQL、ORACLE、MSSQL" 、
      "デフォルト": "MySQL"
    },
    "VaultId": {
      "Type": "String",
      "Description": "バックアップ計画を作成するためのVault ID、バックアップデータはvaultに保存されます。
      "デフォルト": "v-df ****"
    },
    "ソース": {
      "Type": "Json",
      "Description": "どのデータベースインスタンスまたはデータベースをバックアップするか" 、
      "デフォルト": "{\n \" エントリ \": [\n \" mysql:// MySQL-3306\"\n ]\n}"
    },
    "ContinuousPlan": {
      "Type": "String",
      "Description": "継続的なバックアップ計画のスケジュール。 { \"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": "ネットワーク障害の最大再試行秒" 、
      "デフォルト": "600"
    },
    "HostUuid": {
      "Type": "String",
      "Description": "データベースインスタンスのホストのUuid。" 、
      "デフォルト": "701781640b3afc ****"
    },
    "FullPlan": {
      "Type": "String",
      "説明": "完全バックアップ計画のスケジュール。 毎日: {\"type\": \"daily\" 、\"start\": \"00:00:00\" 、\"interval\": 3} 、毎週 {\"type\": \"weekly\" 、\"start\": \"03:00:00\" 、\"days\": [1,2、3,4、5] 、\"interval\": 1} 、日は0〜6、0は日曜日、間隔は1〜52です。"、
      "Default": "{\n \" days\": [\n 6\n ],\n \" interval\": 1,\n \" start\": \" 18:00:00\",\n \" type\": \" weekly\"\n }"
    },
    "DbPlanName": {
      "Type": "String",
      "Description": "バックアッププランの表示名" 、
      "デフォルト": "テスト"
    }
  },
  "Resources": {
    "HBRDbPlan": {
      "タイプ": "ALIYUN::HBR::DbPlan" 、
      "Properties": {
        "Options": {
          "Ref": "オプション"
        },
        "InstanceUuid": {
          "Ref": "InstanceUuid"
        },
        "SourceType": {
          "Ref": "SourceType"
        },
        "VaultId": {
          "Ref": "VaultId"
        },
        "ソース": {
          "Ref": "ソース"
        },
        "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" 、
          「オプション」
        ]
      }
    },
    "InstanceUuid": {
      "Description": "データベースインスタンスのUuid" 、
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan" 、
          "InstanceUuid"
        ]
      }
    },
    "CumulativeUuid": {
      「説明」: 「累積計画の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": "バックアップ計画を作成するためのVault ID、バックアップデータはvaultに保存されます。
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan" 、
          "VaultId"
        ]
      }
    },
    "IncUuid": {
      "Description": "増分bakcupプランの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」
        ]
      }
    },
    "ターゲット": {
      "説明": "コンテナーをバックアップする対象" 、
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan" 、
          「ターゲット」
        ]
      }
    },
    "HostUuid": {
      "Description": "データベースインスタンスのホストのUuid。" 、
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan" 、
          「HostUuid」
        ]
      }
    },
    "ContinuousUuid": {
      「説明」: 「継続バックアップ計画のUuid」、
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan" 、
          「ContinuousUuid」
        ]
      }
    },
    "CumulativePlan": {
      "Description": "累積計画スケジュール、mssqlのみ。 詳細については、FullPlanを参照してください。
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan" 、
          "CumulativePlan"
        ]
      }
    },
    "FullPlan": {
      "説明": "完全バックアップ計画のスケジュール。 毎日: {\"type\": \"daily\" 、\"start\": \"00:00:00\" 、\"interval\": 3} 、毎週 {\"type\": \"weekly\" 、\"start\": \"03:00:00\" 、\"days\": [1,2、3,4、5] 、\"interval\": 1} 、日は0〜6、0は日曜日、間隔は1〜52です。"、
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan" 、
          "FullPlan"
        ]
      }
    },
    "LogPlan": {
      "Description": "ログバックアップ計画のスケジュール。 詳細については、FullPlanを参照してください。
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan" 、
          「LogPlan」
        ]
      }
    },
    "MaxRateLimit": {
      「説明」: 「バックアップジョブの最大レート制限」、
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan" 、
          "MaxRateLimit"
        ]
      }
    },
    "FullUuid": {
      "説明": "完全バックアップ計画のUuid。" 、
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan" 、
          "FullUuid"
        ]
      }
    },
    "DbPlanName": {
      "Description": "バックアッププランの表示名" 、
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan" 、
          "DbPlanName"
        ]
      }
    }
  }
}