All Products
Search
Document Center

Resource Orchestration Service:ALIYUN::HBR::DbPlan

Last Updated:Jun 17, 2026

Membuat rencana pencadangan database.

Sintaks

{
  "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
  }
}

Properti

Properti Tipe Wajib Boleh Diperbarui Deskripsi Batasan
Options String Tidak Tidak Opsi backup. Nilainya berupa string JSON yang bervariasi berdasarkan SourceType.
  • Jika SourceType adalah ORACLE, contoh nilainya adalah {"channels":4,"compression":"lzop","offline_backup":false,"archivelog_reserve_hours":24,"custom_commands":""}
    • channels: Jumlah pekerjaan konkuren.
    • archivelog_reserve_hours: Lama waktu (dalam jam) untuk menyimpan log arsip setelah backup selesai.
    • Gunakan nilai default untuk parameter lainnya.
    Catatan Untuk informasi lebih lanjut tentang backup Oracle, lihat Back up an Oracle database.
  • Jika SourceType adalah MYSQL, contoh nilainya adalah {"channels":4,"compression":"lzop","del_binlog":false}

    del_binlog menentukan apakah log biner (binlog) dihapus setelah backup. Hanya berlaku untuk backup log atau backup waktu nyata.

    Catatan Untuk informasi lebih lanjut tentang backup MYSQL, lihat Back up a MYSQL database.
  • Jika SourceType adalah MSSQL, contoh nilainya adalah {\"channels\":4,\"verify\":false,\"compression\":\"lzop\",\"backup_new_databases\":false}
    Catatan Untuk informasi lebih lanjut tentang backup MSSQL, lihat Back up a SQL Server database.
InstanceUuid String Tidak Tidak UUID dari instans database. Tidak ada
SourceType String Ya Ya Jenis sumber data. Nilai yang valid:
  • MYSQL
  • ORACLE
  • MSSQL
VaultId String Ya Tidak ID repositori Tidak ada
Source Map Tidak Tidak Instans database yang akan di-backup. Untuk informasi lebih lanjut, lihat Source syntax dan Source properties.
ContinuousPlan String Tidak Ya Jadwal backup log berkelanjutan. Nilai: {"type": "continuous"}.
IncPlan String Tidak Ya Jadwal backup inkremental.

Parameter ini hanya berlaku untuk sumber data MYSQL dan ORACLE.

Nilainya berupa string JSON. Contoh:
  • Untuk backup berkala harian: {"type": "daily", "start": "00:00:00", "interval": 3}
  • Untuk backup berkala mingguan: {"type":"weekly","start": "03:00:00","days": [1,2,3,4,5],"interval": 1}
Catatan
  • day menentukan hari dalam minggu. Nilai yang valid: 0 hingga 6. 0 menunjukkan Minggu.
  • interval menentukan periode interval. Nilai yang valid: 1 hingga 52.
MaxRetrySeconds Integer Tidak Ya Periode timeout koneksi ulang. Jumlah detik menunggu sebelum terhubung kembali ke database setelah terputus selama backup. Nilai default: 600.
HostUuid String Ya Tidak UUID dari host client. Tidak ada
CumulativePlan String Tidak Ya Jadwal backup inkremental kumulatif.

Parameter ini hanya berlaku untuk sumber data MSSQL.

Nilainya berupa string JSON. Contoh:
  • Untuk backup berkala harian: {"type": "daily", "start": "00:00:00", "interval": 3}
  • Untuk backup berkala mingguan: {"type":"weekly","start": "03:00:00","days": [1,2,3,4,5],"interval": 1}
Catatan
  • day menentukan hari dalam minggu. Nilai yang valid: 0 hingga 6. 0 menunjukkan Minggu.
  • interval menentukan periode interval. Nilai yang valid: 1 hingga 52.
FullPlan String Tidak Ya Jadwal backup penuh. Nilainya berupa string JSON. Contoh:
  • Untuk backup berkala harian: {"type": "daily", "start": "00:00:00", "interval": 3}
  • Untuk backup berkala mingguan: {"type":"weekly","start": "03:00:00","days": [1,2,3,4,5],"interval": 1}
Catatan
  • day menentukan hari dalam minggu. Nilai yang valid: 0 hingga 6. 0 menunjukkan Minggu.
  • interval menentukan periode interval. Nilai yang valid: 1 hingga 52.
LogPlan String Tidak Ya Jadwal backup log. Nilainya berupa string JSON. Contoh:
  • Untuk backup berkala harian: {"type": "daily", "start": "00:00:00", "interval": 3}
  • Untuk backup berkala mingguan: {"type":"weekly","start": "03:00:00","days": [1,2,3,4,5],"interval": 1}
Catatan
  • day menentukan hari dalam minggu. Nilai yang valid: 0 hingga 6. 0 menunjukkan Minggu.
  • interval menentukan periode interval. Nilai yang valid: 1 hingga 52.
MaxRateLimit Integer Tidak Ya Batas kecepatan. Nilai default: 0, yang berarti tidak ada batas kecepatan.
DbPlanName String Ya Ya Nama backup plan. Tidak ada

Source syntax

"Source": {
  "Entries": List
}

Source properties

Properti Tipe Wajib Boleh Diperbarui Deskripsi Batasan
Entries List Tidak Tidak Sumber backup. Nilai yang valid:
  • Jika SourceType adalah ORACLE: ["oracle://${instanceName}", "oracle://${instanceName}/archivelog"].

    ${instanceName} adalah nama instans database Oracle. Anda dapat memperoleh nama ini dari resource dbAgent (ORACLE).

  • Jika SourceType adalah MYSQL: ["mysql://${instanceName}"].

    ${instanceName} adalah nama instans database MYSQL. Anda dapat memperoleh nama ini dari resource dbAgent (MySQL).

  • Jika SourceType adalah MSSQL: ["mssql://${instanceName}/${database1}", "mssql://${instanceName}/${database2}"].

    ${database} dapat diperoleh dari resource dbAgent (MSSQL).

Nilai kembalian

Fn::GetAtt

  • Options: Opsi pencadangan dalam format JSON.
  • InstanceUuid: UUID dari instans database.
  • CumulativeUuid: UUID dari rencana kumulatif.
  • SourceType: Jenis database.
  • PlanId: ID dari rencana pencadangan.
  • LogUuid: UUID dari rencana pencadangan log.
  • VaultId: ID dari repositori pencadangan.
  • IncUuid: UUID dari rencana pencadangan inkremental.
  • ContinuousPlan: Jadwal pencadangan log berkelanjutan.
  • IncPlan: Jadwal pencadangan inkremental.
  • MaxRetrySeconds: Periode timeout untuk koneksi ulang.
  • Target: Target pencadangan.
  • HostUuid: UUID dari host client.
  • ContinuousUuid: UUID dari rencana pencadangan log berkelanjutan.
  • CumulativePlan: Jadwal pencadangan kumulatif inkremental.
  • FullPlan: Jadwal pencadangan penuh.
  • LogPlan: Jadwal pencadangan log.
  • MaxRateLimit: Batas laju maksimum.
  • FullUuid: UUID dari rencana backup penuh.
  • DbPlanName: Nama backup plan.

Contoh

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Options": {
      "Type": "String",
      "Description": "Opsi backup dalam format JSON. Nilainya berbeda-beda untuk setiap jenis database. Untuk Oracle, gunakan {\"channels\":4,\"compression\":\"lzop\",\"offline_backup\":false,\"archivelog_reserve_hours\":24,\"custom_commands\":\"\"}. Parameter channels menentukan jumlah thread konkuren. Parameter archivelog_reserve_hours menentukan lama waktu (dalam jam) sebelum log arsip dihapus setelah pekerjaan backup selesai. Gunakan nilai default untuk parameter lainnya. Untuk MySQL, gunakan {\"channels\":4,\"compression\":\"lzop\",\"del_binlog\":false}. Parameter del_binlog menentukan apakah log biner (binlog) dihapus setelah backup selesai. Parameter ini hanya berlaku untuk backup log atau backup waktu nyata. Untuk SQL Server, gunakan {\\\"channels\\\":4,\\\"verify\\\":false,\\\"compression\\\":\\\"lzop\\\",\\\"backup_new_databases\\\":false}.",
      "Default": "{\"channels\":4,\"compression\":\"lzop\",\"del_binlog\":false}"
    },
    "InstanceUuid": {
      "Type": "String",
      "Description": "UUID dari instans database.",
      "Default": "d12729b82116154****"
    },
    "SourceType": {
      "Type": "String",
      "Description": "Jenis database. Nilai yang valid: MYSQL, ORACLE, dan MSSQL.",
      "Default": "MYSQL"
    },
    "VaultId": {
      "Type": "String",
      "Description": "ID repositori backup tempat backup plan dibuat. Data backup disimpan di repositori tersebut.",
      "Default": "v-df****"
    },
    "Source": {
      "Type": "Json",
      "Description": "Instans database atau database yang akan di-backup.",
      "Default": "{\n  \"Entries\": [\n    \"mysql://MYSQL-3306\"\n  ]\n}"
    },
    "ContinuousPlan": {
      "Type": "String",
      "Description": "Jadwal backup berkelanjutan. Gunakan { \"type\": \"continuous\" }.",
      "Default": "continuous"
    },
    "IncPlan": {
      "Type": "String",
      "Description": "Jadwal backup inkremental. Parameter ini hanya berlaku untuk MySQL dan Oracle. Untuk informasi lebih lanjut, lihat FullPlan.",
      "Default": "{\n    \"interval\": 1,\n    \"start\": \"00:00:00\",\n    \"type\": \"daily\"\n  }"
    },
    "MaxRetrySeconds": {
      "Type": "Number",
      "Description": "Jumlah maksimum detik retry saat terjadi kegagalan jaringan.",
      "Default": "600"
    },
    "HostUuid": {
      "Type": "String",
      "Description": "UUID dari host tempat instans database berada.",
      "Default": "701781640b3afc****"
    },
    "FullPlan": {
      "Type": "String",
      "Description": "Jadwal backup penuh. Untuk backup harian, gunakan: {\"type\": \"daily\", \"start\": \"00:00:00\", \"interval\": 3}. Untuk backup mingguan, gunakan: {\"type\":\"weekly\",\"start\": \"03:00:00\",\"days\": [1,2,3,4,5],\"interval\": 1}. Parameter days bernilai 0 hingga 6, dengan 0 menunjukkan Minggu. Interval bernilai 1 hingga 52.",
      "Default": "{\n    \"days\": [\n      6\n    ],\n    \"interval\": 1,\n    \"start\": \"18:00:00\",\n    \"type\": \"weekly\"\n  }"
    },
    "DbPlanName": {
      "Type": "String",
      "Description": "Nama tampilan backup plan.",
      "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": "Opsi backup dalam format JSON. Nilainya berbeda-beda untuk setiap jenis database. Untuk Oracle, gunakan {\"channels\":4,\"compression\":\"lzop\",\"offline_backup\":false,\"archivelog_reserve_hours\":24,\"custom_commands\":\"\"}. Parameter channels menentukan jumlah thread konkuren. Parameter archivelog_reserve_hours menentukan lama waktu (dalam jam) sebelum log arsip dihapus setelah pekerjaan backup selesai. Gunakan nilai default untuk parameter lainnya. Untuk MySQL, gunakan {\"channels\":4,\"compression\":\"lzop\",\"del_binlog\":false}. Parameter del_binlog menentukan apakah log biner (binlog) dihapus setelah backup selesai. Parameter ini hanya berlaku untuk backup log atau backup waktu nyata. Untuk SQL Server, gunakan {\\\"channels\\\":4,\\\"verify\\\":false,\\\"compression\\\":\\\"lzop\\\",\\\"backup_new_databases\\\":false}.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "Options"
        ]
      }
    },
    "InstanceUuid": {
      "Description": "UUID dari instans database.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "InstanceUuid"
        ]
      }
    },
    "CumulativeUuid": {
      "Description": "UUID dari rencana kumulatif.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "CumulativeUuid"
        ]
      }
    },
    "SourceType": {
      "Description": "Jenis database. Nilai yang valid: MYSQL, ORACLE, dan MSSQL.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "SourceType"
        ]
      }
    },
    "PlanId": {
      "Description": "ID dari backup plan.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "PlanId"
        ]
      }
    },
    "LogUuid": {
      "Description": "UUID dari rencana backup log.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "LogUuid"
        ]
      }
    },
    "VaultId": {
      "Description": "ID repositori backup tempat backup plan dibuat. Data backup disimpan di repositori tersebut.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "VaultId"
        ]
      }
    },
    "IncUuid": {
      "Description": "UUID dari rencana backup inkremental.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "IncUuid"
        ]
      }
    },
    "ContinuousPlan": {
      "Description": "Jadwal backup berkelanjutan. Gunakan { \"type\": \"continuous\" }.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "ContinuousPlan"
        ]
      }
    },
    "IncPlan": {
      "Description": "Jadwal backup inkremental. Parameter ini hanya berlaku untuk MySQL dan Oracle. Untuk informasi lebih lanjut, lihat FullPlan.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "IncPlan"
        ]
      }
    },
    "MaxRetrySeconds": {
      "Description": "Jumlah maksimum detik retry saat terjadi kegagalan jaringan.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "MaxRetrySeconds"
        ]
      }
    },
    "Target": {
      "Description": "Repositori backup target.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "Target"
        ]
      }
    },
    "HostUuid": {
      "Description": "UUID dari host tempat instans database berada.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "HostUuid"
        ]
      }
    },
    "ContinuousUuid": {
      "Description": "UUID dari rencana backup berkelanjutan.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "ContinuousUuid"
        ]
      }
    },
    "CumulativePlan": {
      "Description": "Jadwal backup kumulatif. Parameter ini hanya berlaku untuk MSSQL. Untuk informasi lebih lanjut, lihat FullPlan.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "CumulativePlan"
        ]
      }
    },
    "FullPlan": {
      "Description": "Jadwal backup penuh. Untuk backup harian, gunakan: {\"type\": \"daily\", \"start\": \"00:00:00\", \"interval\": 3}. Untuk backup mingguan, gunakan: {\"type\":\"weekly\",\"start\": \"03:00:00\",\"days\": [1,2,3,4,5],\"interval\": 1}. Parameter days bernilai 0 hingga 6, dengan 0 menunjukkan Minggu. Interval bernilai 1 hingga 52.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "FullPlan"
        ]
      }
    },
    "LogPlan": {
      "Description": "Jadwal backup log. Untuk informasi lebih lanjut, lihat FullPlan.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "LogPlan"
        ]
      }
    },
    "MaxRateLimit": {
      "Description": "Batas laju maksimum untuk pekerjaan backup.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "MaxRateLimit"
        ]
      }
    },
    "FullUuid": {
      "Description": "UUID dari rencana backup penuh.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "FullUuid"
        ]
      }
    },
    "DbPlanName": {
      "Description": "Nama tampilan backup plan.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "DbPlanName"
        ]
      }
    }
  }
}