All Products
Search

This Product

    Cloud Backup:UpdateBackupPlan

    Document Center

    Cloud Backup:UpdateBackupPlan

    Last Updated:Jun 11, 2026

    Memperbarui rencana pencadangan.

    Coba sekarang

    Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

    Test

    RAM authorization

    Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

    • Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.

    • API: API yang dapat Anda panggil untuk melakukan aksi tersebut.

    • Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.

    • Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.

      • Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.

      • Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.

    • Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.

    • Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    hbr:UpdateBackupPlan

    update

    *All Resource

    *

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    PlanId

    string

    Yes

    ID rencana pencadangan.

    plan-20211***735
    PlanName

    string

    No

    Nama rencana pencadangan.

    planname
    Schedule

    string

    No

    Kebijakan pencadangan. Gunakan format I|{startTime}|{interval}. Ini menentukan bahwa tugas pencadangan dijalankan pada interval berulang. {startTime} adalah waktu ketika pencadangan dimulai. {interval} adalah waktu antar tugas. HBR tidak menjalankan tugas pencadangan yang terlewat. Jika tugas pencadangan sebelumnya belum selesai, tugas berikutnya tidak akan dimulai. Sebagai contoh, I|1631685600|P1D berarti pencadangan berjalan sekali sehari, dimulai pukul 14:00:00 pada 15 September 2021.

    • startTime: Waktu mulai pencadangan. Ini adalah stempel waktu UNIX dalam detik.

    • interval: Interval waktu. Gunakan standar ISO 8601. Sebagai contoh, PT1H menentukan interval satu jam. P1D menentukan interval satu hari.

    I|1602673264|P1D
    Retention

    integer

    No

    Jumlah hari untuk menyimpan pencadangan. Nilai minimum adalah 1.

    7
    Prefix

    string

    No

    Parameter ini diperlukan hanya ketika SourceType diatur ke OSS. Parameter ini menentukan prefiks objek yang akan dicadangkan. Setelah Anda menentukan prefiks, hanya objek yang cocok dengan prefiks tersebut yang dicadangkan.

    oss-prefix
    VaultId

    string

    No

    ID repositori pencadangan.

    v-0006******q
    Detail

    object

    No

    Detail pencadangan instans ECS. Ini adalah string JSON.

    • snapshotGroup: Menentukan apakah akan menggunakan grup snapshot-consistent. Fitur ini hanya tersedia ketika semua disk instans adalah Enhanced Solid-State Drive (ESSD).

    • appConsistent: Menentukan apakah akan mengaktifkan konsistensi aplikasi. Anda juga harus mengonfigurasi parameter preScriptPath dan postScriptPath.

    • preScriptPath: Jalur ke skrip pre-freeze.

    • postScriptPath: Jalur ke skrip post-thaw.

    {\"EnableFsFreeze\":true,\"appConsistent\":false,\"postScriptPath\":\"\",\"preScriptPath\":\"\",\"snapshotGroup\":true,\"timeoutInSeconds\":60}
    SourceType

    string

    No

    Jenis sumber data. Nilai yang valid:

    • ECS_FILE: Mencadangkan file ECS.

    • OSS: Mencadangkan Alibaba Cloud OSS.

    • NAS: Mencadangkan Alibaba Cloud NAS.

    • OTS: Mencadangkan Alibaba Cloud Tablestore.

    • UDM_ECS: Mencadangkan seluruh instans ECS.

    ECS_FILE
    SpeedLimit

    string

    No

    Parameter ini diperlukan hanya ketika SourceType diatur ke ECS_FILE. Parameter ini menentukan pembentukan lalu lintas untuk pencadangan. Pembentukan lalu lintas membantu Anda mengendalikan lalu lintas pencadangan selama jam sibuk bisnis untuk menghindari memengaruhi layanan Anda. Formatnya adalah {start}|{end}|{bandwidth}. Anda dapat menentukan beberapa aturan pembentukan lalu lintas. Pisahkan dengan garis vertikal (|). Rentang waktu aturan tidak boleh tumpang tindih.

    • start: Jam mulai.

    • end: Jam akhir.

    • bandwidth: Kecepatan maksimum. Satuan: KB/s.

    0:24:5120
    Include

    string

    No

    Parameter ini diperlukan hanya ketika SourceType diatur ke ECS_FILE. Parameter ini menentukan jalur ke file yang akan dicadangkan. Semua file pada jalur yang ditentukan akan dicadangkan. Nilainya dapat memiliki panjang hingga 255 karakter.

    ["/home/alice/*.pdf", "/home/bob/*.txt"]
    Exclude

    string

    No

    Parameter ini diperlukan hanya ketika SourceType diatur ke ECS_FILE. Parameter ini menentukan jalur ke file yang akan dikecualikan dari pencadangan. Semua file pada jalur yang ditentukan tidak akan dicadangkan. Nilainya dapat memiliki panjang hingga 255 karakter.

    ["/var", "/proc"]
    Options

    string

    No

    Parameter ini diperlukan hanya ketika SourceType diatur ke ECS_FILE. Parameter ini menentukan apakah akan menggunakan Volume Shadow Copy Service (VSS) untuk mendefinisikan jalur pencadangan.

    • Fitur ini hanya tersedia untuk instans ECS Windows.

    • Jika terjadi perubahan data pada sumber pencadangan, atur parameter ini ke ["UseVSS":true] untuk memastikan konsistensi data.

    • Jika Anda mengaktifkan VSS, Anda tidak dapat mencadangkan beberapa direktori file secara bersamaan.

    {"UseVSS":false}
    UpdatePaths

    boolean

    No

    Menentukan apakah akan memperbarui jalur pencadangan jika parameter Path kosong.

    • true: Memperbarui jalur pencadangan berdasarkan jalur yang ditentukan dalam panggilan ini.

    • false: Tidak memperbarui jalur pencadangan. Jalur pencadangan yang dikonfigurasi saat rencana pencadangan dibuat akan digunakan.

    false
    Path

    array

    No

    Jalur pencadangan.

    string

    No

    Jalur pencadangan. Nilainya dapat memiliki panjang hingga 65.536 karakter. Aturan berikut berlaku:

    • Jika Anda tidak menggunakan karakter wildcard (*), Anda dapat memasukkan hingga 20 jalur.

    • Jika Anda menggunakan karakter wildcard (*), Anda hanya dapat memasukkan satu jalur. Karakter wildcard seperti /*/* didukung.

    • Setiap jalur harus berupa jalur absolut.

    • Jika Anda menggunakan VSS, Anda tidak dapat menentukan beberapa jalur, jalur UNC, karakter wildcard, atau file yang dikecualikan.

    • Jika Anda menggunakan jalur UNC, Anda tidak dapat menggunakan VSS, karakter wildcard, atau file yang dikecualikan. Jika sumber pencadangan berisi jalur UNC, Windows Access Control List (ACL) tidak akan dicadangkan.

    ["/home"]
    Rule

    array<object>

    No

    Aturan rencana pencadangan.

    object

    No

    DestinationRetention

    integer

    No

    Jumlah hari untuk menyimpan pencadangan geo-redundant.

    7
    Schedule

    string

    No

    Kebijakan pencadangan. Gunakan format I|{startTime}|{interval}. Ini menentukan bahwa tugas pencadangan dijalankan pada interval berulang. {startTime} adalah waktu ketika pencadangan dimulai. {interval} adalah waktu antar tugas. HBR tidak menjalankan tugas pencadangan yang terlewat. Jika tugas pencadangan sebelumnya belum selesai, tugas berikutnya tidak akan dimulai. Sebagai contoh, I|1631685600|P1D berarti pencadangan berjalan sekali sehari, dimulai pukul 14:00:00 pada 15 September 2021.

    startTime: Waktu mulai pencadangan. Ini adalah stempel waktu UNIX dalam detik. interval: Interval waktu. Gunakan standar ISO 8601. Sebagai contoh, PT1H menentukan interval satu jam. P1D menentukan interval satu hari.

    I|1631685600|P1D
    Disabled

    boolean

    No

    Menentukan apakah akan menonaktifkan kebijakan.

    false
    Retention

    integer

    No

    Jumlah hari untuk menyimpan pencadangan. Nilai minimum adalah 1.

    7
    DoCopy

    boolean

    No

    Menentukan apakah akan mengaktifkan replikasi geo-redundant.

    false
    DestinationRegionId

    string

    No

    ID wilayah tujuan untuk pencadangan geo-redundant.

    cn-shanghai
    RuleName

    string

    No

    Nama kebijakan.

    rule-test-name
    BackupType

    string

    No

    Jenis pencadangan. Atur nilainya ke COMPLETE. Ini menunjukkan pencadangan penuh.

    COMPLETE
    OtsDetail OtsDetail

    No

    Detail instans Tablestore.

    KeepLatestSnapshots

    integer

    No

    Menentukan apakah akan menyimpan versi pencadangan terbaru secara permanen.

    • 0: Tidak

    • 1: Ya

    1
    ChangeListPath

    string

    No

    Konfigurasi untuk daftar sinkronisasi file inkremental. (Parameter ini diperlukan hanya untuk sinkronisasi file.)

    {"dataSourceId": "ds-123456789", "path": "/changelist"}
    Edition

    string

    No

    Edisi. Nilai yang valid adalah BASIC dan STANDARD. Nilai default adalah STANDARD.

    STANDARD

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Code

    string

    Kode pengembalian. Nilai 200 menunjukkan bahwa permintaan berhasil.

    200
    Message

    string

    Pesan yang dikembalikan. Jika permintaan berhasil, `successful` akan dikembalikan. Jika permintaan gagal, pesan kesalahan akan dikembalikan.

    successful
    RequestId

    string

    ID permintaan.

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    Success

    boolean

    Menunjukkan apakah permintaan berhasil.

    • true: Permintaan berhasil.

    • false: Permintaan gagal.

    true

    Contoh

    Respons sukses

    JSONformat

    {
  "Code": "200",
  "Message": "successful",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.