全部产品
Search
文档中心

Resource Orchestration Service:ALIYUN::HBR::DbPlan

更新时间:Jul 02, 2025

ALIYUN::HBR::DbPlan digunakan untuk membuat rencana cadangan.

Sintaksis

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

PropertiTipeDiperlukanDapat DieditDeskripsiKendala
OptionsStringTidakTidakOpsi pencadangan. Nilainya adalah string JSON dan bervariasi berdasarkan nilai SourceType. Contoh nilai:
  • Contoh nilai jika Anda mengatur SourceType ke ORACLE: {"channels":4,"compression":"lzop","offline_backup":false,"archivelog_reserve_hours":24,"custom_commands":""}.
    • channels: jumlah operasi pencadangan bersamaan.
    • archivelog_reserve_hours: waktu untuk menghapus log yang diarsipkan setelah pencadangan selesai.
    • Parameter lainnya dalam contoh nilai: Jika Anda tidak menentukan parameter ini, nilai default mereka akan digunakan.
    Catatan Untuk informasi lebih lanjut tentang cara mencadangkan database Oracle, lihat Cadangkan database Oracle.
  • Contoh nilai jika Anda mengatur SourceType ke MYSQL: {"channels":4,"compression":"lzop","del_binlog":false}.

    del_binlog: menunjukkan apakah akan menghapus log biner setelah pencadangan selesai. Parameter ini hanya berlaku untuk pencadangan log dan pencadangan real-time.

    Catatan Untuk informasi lebih lanjut tentang cara mencadangkan database MySQL, lihat Cadangkan database MySQL.
  • Contoh nilai jika Anda mengatur SourceType ke MSSQL: {\"channels\":4,\"verify\":false,\"compression\":\"lzop\",\"backup_new_databases\":false}.
    Catatan Untuk informasi lebih lanjut tentang cara mencadangkan database SQL Server, lihat Cadangkan database SQL Server.
InstanceUuidStringTidakTidakUUID dari instance database. Tidak ada.
SourceTypeStringYaYaJenis database sumber. Nilai valid:
  • MYSQL
  • ORACLE
  • MSSQL
VaultIdStringYaTidakID dari vault cadangan. Tidak ada.
SourceMapTidakTidakInstance database yang ingin Anda cadangkan. Untuk informasi lebih lanjut, lihat Sintaksis sumber dan Properti sumber.
ContinuousPlanStringTidakYaRencana pencadangan kontinu untuk log. Atur nilainya menjadi {"type": "continuous"}.
IncPlanStringTidakYaRencana pencadangan inkremental.

Parameter ini hanya berlaku untuk database sumber MySQL dan Oracle.

Nilainya adalah string JSON. Contoh nilai:
  • {"type": "daily", "start": "00:00:00", "interval": 3},: Saat Anda mencadangkan database secara harian, nilai ini digunakan.
  • {"type":"weekly","start": "03:00:00","days": [1,2,3,4,5],"interval": 1}: Saat Anda mencadangkan database secara mingguan, nilai ini digunakan.
Catatan
  • day: hari tertentu. Nilai valid day: 0 hingga 6. 0 menunjukkan Minggu.
  • interval: interval antara rencana pencadangan berturut-turut. Nilai valid interval: 1 hingga 52.
MaxRetrySecondsIntegerTidakYaWaktu untuk menyambung ulang ke database setelah database terputus selama pencadangan. Nilai default: 600. Satuan: detik.
HostUuidStringYaTidakUUID dari klien. Tidak ada.
CumulativePlanStringTidakYaRencana pencadangan inkremental kumulatif.

Parameter ini hanya berlaku untuk database sumber SQL Server.

Nilainya adalah string JSON. Contoh nilai:
  • {"type": "daily", "start": "00:00:00", "interval": 3},: Saat Anda mencadangkan database secara harian, nilai ini digunakan.
  • {"type":"weekly","start": "03:00:00","days": [1,2,3,4,5],"interval": 1}: Saat Anda mencadangkan database secara mingguan, nilai ini digunakan.
Catatan
  • day: hari tertentu. Nilai valid day: 0 hingga 6. 0 menunjukkan Minggu.
  • interval: interval antara rencana pencadangan berturut-turut. Nilai valid interval: 1 hingga 52.
FullPlanStringTidakYaRencana pencadangan penuh. Nilainya adalah string JSON. Contoh nilai:
  • {"type": "daily", "start": "00:00:00", "interval": 3},: Saat Anda mencadangkan database secara harian, nilai ini digunakan.
  • {"type":"weekly","start": "03:00:00","days": [1,2,3,4,5],"interval": 1}: Saat Anda mencadangkan database secara mingguan, nilai ini digunakan.
Catatan
  • day: hari tertentu. Nilai valid day: 0 hingga 6. 0 menunjukkan Minggu.
  • interval: interval antara rencana pencadangan berturut-turut. Nilai valid interval: 1 hingga 52.
LogPlanStringTidakYaRencana pencadangan untuk log. Nilainya adalah string JSON. Contoh nilai:
  • {"type": "daily", "start": "00:00:00", "interval": 3},: Saat Anda mencadangkan database secara harian, nilai ini digunakan.
  • {"type":"weekly","start": "03:00:00","days": [1,2,3,4,5],"interval": 1}: Saat Anda mencadangkan database secara mingguan, nilai ini digunakan.
Catatan
  • day: hari tertentu. Nilai valid day: 0 hingga 6. 0 menunjukkan Minggu.
  • interval: interval antara rencana pencadangan berturut-turut. Nilai valid interval: 1 hingga 52.
MaxRateLimitIntegerTidakYaNilai maksimum dari kecepatan pencadangan. Nilai default: 0. 0 menunjukkan bahwa kecepatan pencadangan tidak dibatasi.
DbPlanNameStringYaYaNama dari rencana pencadangan. Tidak ada.

Sintaksis sumber

"Source": {
  "Entries": List
}

Properti sumber

PropertiTipeDiperlukanDapat DieditDeskripsiKendala
EntriesListTidakTidakInstance database sumber. Nilai valid:
  • Nilai valid jika Anda mengatur SourceType ke ORACLE: ["oracle://${instanceName}", "oracle://${instanceName}/archivelog"].

    ${instanceName}: nama dari instance database Oracle. Anda dapat menentukan tipe sumber daya ALIYUN::HBR::DbAgent untuk mendapatkan nama tersebut.

  • Nilai valid jika Anda mengatur SourceType ke MYSQL: ["mysql://${instanceName}"].

    ${instanceName}: nama dari instance database MySQL. Anda dapat menentukan tipe sumber daya ALIYUN::HBR::DbAgent untuk mendapatkan nama tersebut.

  • Nilai valid jika Anda mengatur SourceType ke MSSQL: ["mssql://${instanceName}/${databse1}", "mssql://${instanceName}/${databse2}"].

    ${database}: nama dari database SQL Server. Anda dapat menentukan tipe sumber daya ALIYUN::HBR::DbAgent untuk mendapatkan nama tersebut.

Parameter respons

Fn::GetAtt

  • Options: Opsi pencadangan dalam format JSON.
  • InstanceId: ID instance database.
  • CumulativeUuid: ID rencana pencadangan inkremental kumulatif.
  • SourceType: Jenis database sumber.
  • PlanId: ID rencana pencadangan.
  • LogUuid: ID log.
  • VaultId: ID vault cadangan.
  • IncUuid: ID rencana pencadangan inkremental.
  • ContinuousPlan: Rencana pencadangan kontinu untuk log.
  • IncPlan: Rencana pencadangan inkremental.
  • MaxRetrySeconds: Waktu yang dikonsumsi untuk menyambung ulang ke database setelah terputus.
  • Target: Database yang dicadangkan.
  • HostUuid: UUID klien.
  • ContinuousUuid: UUID rencana pencadangan kontinu untuk log.
  • CumulativePlan: Rencana pencadangan inkremental kumulatif.
  • FullPlan: Rencana pencadangan penuh.
  • LogPlan: Rencana pencadangan log.
  • MaxRateLimit: Nilai maksimum kecepatan pencadangan.
  • FullUuid: UUID rencana pencadangan penuh.
  • DbPlanName: Nama rencana pencadangan.

Contoh

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Options": {
      "Type": "String",
      "Description": "Opsi pencadangan dalam format json, berbeda untuk setiap jenis database. Untuk Oracle, gunakan {\"channels\":4,\"compression\":\"lzop\",\"offline_backup\":false,\"archivelog_reserve_hours\":24,\"custom_commands\":\"\"}, \"channels\" berarti jumlah thread bersamaan, \"archivelog_reserve_hours\" berarti berapa lama sebelum log arsip akan dihapus setelah pekerjaan pencadangan selesai, parameter lainnya harus menggunakan nilai default. Untuk Mysql, gunakan {\"channels\":4,\"compression\":\"lzop\",\"del_binlog\":false}, \"del_binlog\" berarti apakah binlog akan dihapus setelah pencadangan selesai, hanya berlaku untuk pencadangan log atau kontinu. 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 instance database.",
      "Default": "d12729b82116154****"
    },
    "SourceType": {
      "Type": "String",
      "Description": "Jenis database, nilai yang diizinkan: MySQL, ORACLE, MSSQL",
      "Default": "MySQL"
    },
    "VaultId": {
      "Type": "String",
      "Description": "ID Vault untuk membuat rencana pencadangan, data cadangan akan disimpan ke vault.",
      "Default": "v-df****"
    },
    "Source": {
      "Type": "Json",
      "Description": "Database instance atau database mana yang akan dicadangkan.",
      "Default": "{\n  \"Entries\": [\n    \"mysql://MySQL-3306\"\n  ]\n}"
    },
    "ContinuousPlan": {
      "Type": "String",
      "Description": "Jadwal rencana pencadangan kontinu. Gunakan {   \"type\": \"continuous\" }.",
      "Default": "continuous"
    },
    "IncPlan": {
      "Type": "String",
      "Description": "Jadwal rencana pencadangan inkremental. Hanya untuk mysql dan oracle. Lihat FullPlan untuk detail lebih lanjut.",
      "Default": "{\n    \"interval\": 1,\n    \"start\": \"00:00:00\",\n    \"type\": \"daily\"\n  }"
    },
    "MaxRetrySeconds": {
      "Type": "Number",
      "Description": "Maksimum detik pengulangan pada kegagalan jaringan.",
      "Default": "600"
    },
    "HostUuid": {
      "Type": "String",
      "Description": "Uuid dari host dari instance database.",
      "Default": "701781640b3afc****"
    },
    "FullPlan": {
      "Type": "String",
      "Description": "Jadwal rencana pencadangan penuh. daily: {\"type\": \"daily\", \"start\": \"00:00:00\", \"interval\": 3}, weekly {\"type\":\"weekly\",\"start\": \"03:00:00\",\"days\": [1,2,3,4,5],\"interval\": 1}, days bisa 0 - 6, 0 berarti Minggu, dan interval bisa 1 - 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 dari rencana pencadangan.",
      "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 pencadangan dalam format json, berbeda untuk setiap jenis database. Untuk Oracle, gunakan {\"channels\":4,\"compression\":\"lzop\",\"offline_backup\":false,\"archivelog_reserve_hours\":24,\"custom_commands\":\"\"}, \"channels\" berarti jumlah thread bersamaan, \"archivelog_reserve_hours\" berarti berapa lama sebelum log arsip akan dihapus setelah pekerjaan pencadangan selesai, parameter lainnya harus menggunakan nilai default. Untuk Mysql, gunakan {\"channels\":4,\"compression\":\"lzop\",\"del_binlog\":false}, \"del_binlog\" berarti apakah binlog akan dihapus setelah pencadangan selesai, hanya berlaku untuk pencadangan log atau kontinu. Untuk SQL Server, gunakan {\\\"channels\\\":4,\\\"verify\\\":false,\\\"compression\\\":\\\"lzop\\\",\\\"backup_new_databases\\\":false}.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "Options"
        ]
      }
    },
    "InstanceUuid": {
      "Description": "Uuid dari instance database.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "InstanceUuid"
        ]
      }
    },
    "CumulativeUuid": {
      "Description": "Uuid dari rencana kumulatif.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "CumulativeUuid"
        ]
      }
    },
    "SourceType": {
      "Description": "Jenis database, nilai yang diizinkan: MySQL, ORACLE, MSSQL",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "SourceType"
        ]
      }
    },
    "PlanId": {
      "Description": "Id dari rencana pencadangan.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "PlanId"
        ]
      }
    },
    "LogUuid": {
      "Description": "Uuid dari rencana pencadangan log.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "LogUuid"
        ]
      }
    },
    "VaultId": {
      "Description": "ID Vault untuk membuat rencana pencadangan, data cadangan akan disimpan ke vault.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "VaultId"
        ]
      }
    },
    "IncUuid": {
      "Description": "Uuid dari rencana pencadangan inkremental.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "IncUuid"
        ]
      }
    },
    "ContinuousPlan": {
      "Description": "Jadwal rencana pencadangan kontinu. Gunakan {   \"type\": \"continuous\" }.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "ContinuousPlan"
        ]
      }
    },
    "IncPlan": {
      "Description": "Jadwal rencana pencadangan inkremental. Hanya untuk mysql dan oracle. Lihat FullPlan untuk detail lebih lanjut.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "IncPlan"
        ]
      }
    },
    "MaxRetrySeconds": {
      "Description": "Maksimum detik pengulangan pada kegagalan jaringan.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "MaxRetrySeconds"
        ]
      }
    },
    "Target": {
      "Description": "Vault target untuk pencadangan.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "Target"
        ]
      }
    },
    "HostUuid": {
      "Description": "Uuid dari host dari instance database.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "HostUuid"
        ]
      }
    },
    "ContinuousUuid": {
      "Description": "Uuid dari rencana pencadangan kontinu.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "ContinuousUuid"
        ]
      }
    },
    "CumulativePlan": {
      "Description": "Jadwal rencana kumulatif, hanya untuk mssql. Lihat FullPlan untuk detail lebih lanjut.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "CumulativePlan"
        ]
      }
    },
    "FullPlan": {
      "Description": "Jadwal rencana pencadangan penuh. daily: {\"type\": \"daily\", \"start\": \"00:00:00\", \"interval\": 3}, weekly {\"type\":\"weekly\",\"start\": \"03:00:00\",\"days\": [1,2,3,4,5],\"interval\": 1}, days bisa 0 - 6, 0 berarti Minggu, dan interval bisa 1 - 52.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "FullPlan"
        ]
      }
    },
    "LogPlan": {
      "Description": "Jadwal rencana pencadangan log. Lihat FullPlan untuk detail lebih lanjut.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "LogPlan"
        ]
      }
    },
    "MaxRateLimit": {
      "Description": "Batas laju maksimum untuk pekerjaan pencadangan,",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "MaxRateLimit"
        ]
      }
    },
    "FullUuid": {
      "Description": "Uuid dari rencana pencadangan penuh.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "FullUuid"
        ]
      }
    },
    "DbPlanName": {
      "Description": "Nama tampilan dari rencana pencadangan.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbPlan",
          "DbPlanName"
        ]
      }
    }
  }
}