All Products
Search

This Product

    Cloud Backup:CreateBackupPlan

    Document Center

    Cloud Backup:CreateBackupPlan

    Last Updated:Aug 07, 2026

    Membuat backup plan.

    Deskripsi operasi

    Penting

    • Untuk menggunakan fitur seperti ECS File Backup Essential Edition, backup cloud disk, backup container, uji coba gratis Tablestore backup, arsip, atau sinkronisasi data, panggil operasi ini.

    • Untuk mengaktifkan uji coba gratis 30 hari untuk NAS backup atau OSS backup, panggil operasi CreateTrialBackupPlan.

    • Untuk menggunakan kemampuan standar seperti ECS File Backup Standard Edition, backup file lokal, backup full-copy ECS, NAS backup, OSS backup, atau CPFS backup, panggil operasi CreatePolicyV2 dan CreatePolicyBindings.

    • Backup plan mengaitkan sumber data dengan kebijakan cadangan dan informasi lain yang diperlukan untuk pencadangan. Setelah dijalankan, backup plan akan membuat pekerjaan cadangan (backup job) untuk mencatat progres dan hasil pencadangan. Jika pekerjaan cadangan berhasil, snapshot cadangan (backup snapshot) akan dihasilkan. Snapshot tersebut dapat digunakan untuk membuat pekerjaan pemulihan (restore job).

    • Backup plan hanya mendukung satu sumber data.

    • Backup plan hanya mendukung satu kebijakan siklus backup dengan interval tetap.

    • Backup plan hanya dapat mencadangkan data ke satu vault.

    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:CreateBackupPlan

    create

    *Semua sumber daya.

    *

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    SourceType

    string

    Yes

    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 OTS.

    • UDM_ECS: mencadangkan seluruh instance ECS.

    • SYNC: sinkronisasi data.

    ECS_FILE
    PlanName

    string

    No

    Nama backup plan. Nama harus terdiri dari 1 hingga 64 karakter. Nama backup plan harus unik untuk setiap jenis sumber data dalam satu vault.

    planname
    BackupType

    string

    No

    Jenis backup. Tetapkan nilainya ke COMPLETE, yang menunjukkan cadangan penuh (full backup).

    COMPLETE
    VaultId

    string

    No

    ID vault.

    v-0006******q
    Schedule

    string

    No

    Kebijakan backup. Format: I|{startTime}|{interval}. Ini menunjukkan bahwa pekerjaan cadangan dijalankan setiap {interval} mulai dari {startTime}. Pekerjaan cadangan untuk periode waktu lampau tidak dikompensasi. Jika pekerjaan cadangan sebelumnya belum selesai, pekerjaan cadangan berikutnya tidak dipicu. Contoh: I|1631685600|P1D menunjukkan bahwa backup dilakukan sekali sehari mulai dari 2021-09-15 14:00:00.

    • startTime: waktu mulai backup. Nilainya berupa Stempel waktu UNIX. Satuan: detik.

    • interval: interval waktu ISO 8601. Contoh: PT1H menunjukkan interval satu jam. P1D menunjukkan interval satu hari.

    I|1602673264|P1D
    Retention

    integer

    No

    Periode retensi data backup. Nilai minimum: 1. Satuan: hari.

    7
    ClusterId

    string

    No

    ID grup client yang menjalankan rencana sinkronisasi data. Parameter ini hanya diperlukan untuk sinkronisasi data.

    cl-***************
    FileSystemId

    string

    No

    Parameter ini hanya diperlukan ketika SourceType diatur ke NAS. ID sistem file.

    005494
    CreateTime

    integer

    No

    Parameter ini hanya diperlukan ketika SourceType diatur ke NAS. Waktu pembuatan sistem file. Nilainya berupa Stempel waktu UNIX. Satuan: detik.

    1607436917
    Bucket

    string

    No

    Parameter ini hanya diperlukan ketika SourceType diatur ke OSS. Nama Bucket OSS.

    hbr-backup-oss
    Prefix

    string

    No

    Parameter ini hanya diperlukan ketika SourceType diatur ke OSS. Awalan backup. Jika ditentukan, hanya objek yang sesuai dengan awalan tersebut yang akan dicadangkan.

    oss-prefix
    InstanceId

    string

    No

    Parameter ini hanya diperlukan ketika SourceType diatur ke ECS_FILE. ID instance ECS.

    i-m5e*****6q
    Detail

    object

    No

    Detail backup full-copy. Nilainya berupa string JSON.

    • snapshotGroup: menentukan apakah akan menggunakan grup snapshot konsisten. Parameter ini hanya berlaku jika semua cloud disk instance berupa ESSD.

    • appConsistent: menentukan apakah akan menggunakan konsistensi aplikasi. Parameter ini harus digunakan bersama parameter preScriptPath dan postScriptPath.

    • preScriptPath: jalur skrip pra-pembekuan (pre-freeze script).

    • postScriptPath: jalur skrip pasca-thaw (post-thaw script).

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

    string

    No

    Wilayah tempat instance ECS untuk backup full-copy berada.

    cn-shanghai
    SpeedLimit

    string

    No

    Parameter ini hanya diperlukan ketika SourceType diatur ke ECS_FILE. Pengaturan bandwidth backup. Format: {start}:{end}:{bandwidth}. Pisahkan beberapa konfigurasi pengaturan bandwidth dengan tanda pipa vertikal (|). Rentang waktu konfigurasi tidak boleh tumpang tindih.

    • start: jam mulai.

    • end: jam selesai.

    • bandwidth: batas laju. Satuan: KB/s.

    0:24:5120
    Include

    string

    No

    Parameter ini hanya diperlukan ketika SourceType diatur ke ECS_FILE. Jalur yang disertakan dalam backup. Semua file dalam jalur ini akan dicadangkan. Nilainya dapat memiliki panjang hingga 255 karakter.

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

    string

    No

    Parameter ini hanya diperlukan ketika SourceType diatur ke ECS_FILE. Jalur yang dikecualikan dari backup. Semua file dalam jalur ini tidak akan dicadangkan. Nilainya dapat memiliki panjang hingga 255 karakter.

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

    string

    No

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

    • Fitur ini hanya didukung untuk instance ECS Windows.

    • Jika sumber cadangan berisi perubahan data dan Anda perlu memastikan konsistensi antara data cadangan dan data sumber, atur parameter ini ke ["UseVSS":true].

    • Setelah VSS diaktifkan, beberapa folder file tidak dapat dicadangkan secara bersamaan.

    {"UseVSS":false}
    DataSourceId

    string

    No

    ID sumber data asal. Parameter ini hanya diperlukan untuk sinkronisasi data.

    ds-****************
    Path

    array

    No

    Jalur sumber.

    string

    No

    Jalur sumber. Nilainya dapat memiliki panjang hingga 65536 karakter. Aturan jalur sumber adalah sebagai berikut:

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

    • Jika menggunakan wildcard (*), Anda hanya dapat memasukkan satu jalur. Wildcard dalam format /*/* didukung.

    • Setiap baris hanya mendukung jalur mutlak.

    • Saat VSS digunakan, beberapa jalur, jalur UNC, wildcard, dan pengecualian file tidak didukung.

    • Saat UNC digunakan, VSS, wildcard, dan pengecualian file tidak didukung. Saat sumber cadangan berisi jalur UNC, ACL Windows tidak dicadangkan.

    ["/home"]
    Rule

    array<object>

    No

    Aturan backup plan.

    object

    No

    Aturan backup plan.

    DestinationRetention

    integer

    No

    Periode retensi backup geo-redundansi. Satuan: hari.

    7
    Schedule

    string

    No

    Kebijakan backup. Format: I|{startTime}|{interval}. Ini menunjukkan bahwa pekerjaan cadangan dijalankan setiap {interval} mulai dari {startTime}. Pekerjaan cadangan untuk periode waktu lampau tidak dijalankan. Jika pekerjaan cadangan sebelumnya belum selesai, pekerjaan cadangan berikutnya tidak dipicu. Contoh: I|1631685600|P1D menunjukkan bahwa backup dilakukan sekali sehari mulai dari 2021-09-15 14:00:00.

    startTime: waktu mulai backup. Nilainya berupa Stempel waktu UNIX. Satuan: detik. interval: interval waktu ISO 8601. Contoh: PT1H menunjukkan interval satu jam. P1D menunjukkan interval satu hari.

    I|1602673264|P1D
    Retention

    integer

    No

    Periode retensi backup.

    7
    Disabled

    boolean

    No

    Menentukan apakah aturan dinonaktifkan.

    false
    DoCopy

    boolean

    No

    Menentukan apakah replikasi lintas wilayah (cross-region replication) diaktifkan.

    false
    DestinationRegionId

    string

    No

    ID wilayah tujuan untuk replikasi lintas wilayah.

    cn-hangzhou
    RuleName

    string

    No

    Nama aturan.

    rule-test-name
    BackupType

    string

    No

    Jenis backup.

    COMPLETE
    InstanceName

    string

    No

    Nama instance Tablestore.

    instancename
    OtsDetail OtsDetail

    No

    Detail instance Tablestore.

    CrossAccountType

    string

    No

    Jenis backup cross-account. Nilai yang valid:

    • SELF_ACCOUNT: backup dalam akun yang sama.

    • CROSS_ACCOUNT: backup lintas akun.

    Valid values:

    • SELF_ACCOUNT :

      SELF_ACCOUNT

    • CROSS_ACCOUNT :

      CROSS_ACCOUNT

    CROSS_ACCOUNT
    CrossAccountUserId

    integer

    No

    ID akun sumber untuk backup lintas akun.

    15897534xxxx4625
    CrossAccountRoleName

    string

    No

    Nama Peran RAM yang dibuat di akun sumber untuk backup lintas akun.

    BackupRole
    KeepLatestSnapshots

    integer

    No

    Menentukan apakah menyimpan setidaknya satu versi backup. Nilai yang valid:

    • 0: tidak menyimpan.

    • 1: menyimpan.

    Valid values:

    • 0 :

      Tidak menyimpan.

    • 1 :

      Menyimpan.

    1
    DestSourceType

    string

    No

    Jenis sumber data tujuan. Parameter ini hanya diperlukan untuk sinkronisasi data.

    OSS
    DestDataSourceId

    string

    No

    ID sumber data tujuan. Parameter ini hanya diperlukan untuk sinkronisasi data.

    ds-*********************

    DestDataSourceDetail

    object

    No

    Detail sumber data tujuan. Parameter ini hanya diperlukan untuk sinkronisasi data.

    {\"prefix\":\"/\"}
    ChangeListPath

    string

    No

    Konfigurasi daftar sinkronisasi file inkremental. Parameter ini hanya diperlukan untuk sinkronisasi data.

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

    boolean

    No

    Menentukan apakah rencana dinonaktifkan secara default.

    true
    Edition

    string

    No

    Jenis edisi. Nilai yang valid: BASIC dan STANDARD. Nilai default: STANDARD.

    STANDARD

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Parameter respons.

    Code

    string

    Kode respons. Nilai 200 menunjukkan keberhasilan.

    200
    Message

    string

    Pesan yang dikembalikan. Nilai "successful" dikembalikan untuk respons sukses. Pesan error dikembalikan untuk respons gagal.

    successful
    RequestId

    string

    ID permintaan.

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

    string

    ID backup plan.

    plan-*********************
    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",
  "PlanId": "plan-*********************",
  "Success": true
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.