All Products
Search

This Product

    Cloud Backup:CreateBackupPlan

    Document Center

    Cloud Backup:CreateBackupPlan

    Last Updated:Jun 11, 2026

    Membuat rencana cadangan.

    Deskripsi operasi

    Penting

    • Call this API to use features such as the basic edition of ECS file backup, cloud disk backup, container backup, the free trial of TableStore backup, archiving, or data synchronization.

    • To use the 30-day free trial for NAS backup or OSS backup, call the CreateTrialBackupPlan operation.

    • To use the standard capabilities of ECS file backup, local file backup, ECS instance backup, NAS backup, OSS backup, or CPFS backup, call the CreatePolicyV2 and CreatePolicyBindings operations.

    • Executing a backup plan creates a backup job to record its progress and result. A successful job generates a backup snapshot, which you can use to create a restore job.

    • A backup plan supports only one data source.

    • A backup plan supports only one backup policy with a fixed-interval cycle.

    • A backup plan can back up to only one backup repository.

    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

    *全部资源

    *

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    SourceType

    string

    Yes

    Jenis sumber data. Nilai valid:

    • ECS_FILE: Mencadangkan file dari Instance ECS.

    • OSS: Mencadangkan bucket OSS.

    • NAS: Mencadangkan sistem file NAS.

    • OTS: Mencadangkan Instans Tablestore.

    • UDM_ECS: Mencadangkan seluruh Instance ECS.

    • SYNC: Melakukan sinkronisasi data.

    ECS_FILE
    PlanName

    string

    No

    Nama rencana cadangan. Nama harus terdiri dari 1 hingga 64 karakter. Nama harus unik untuk setiap jenis sumber data dalam repositori cadangan.

    planname
    BackupType

    string

    No

    Jenis cadangan. Atur nilai menjadi COMPLETE, yang menentukan cadangan penuh.

    COMPLETE
    VaultId

    string

    No

    ID repositori cadangan.

    v-0006******q
    Schedule

    string

    No

    Kebijakan cadangan. Formatnya adalah I|{startTime}|{interval}. Ini menentukan bahwa pekerjaan cadangan berjalan dengan interval {interval}, dimulai dari {startTime}. Pekerjaan cadangan yang terlambat tidak akan diulang. Jika pekerjaan cadangan sebelumnya belum selesai, pekerjaan cadangan berikutnya tidak akan dipicu. Misalnya, I|1631685600|P1D menunjukkan bahwa pekerjaan cadangan berjalan setiap hari mulai pukul 14:00:00 pada 15 September 2021.

    • startTime: pengatur waktu mulai cadangan, ditentukan sebagai stempel waktu UNIX dalam detik.

    • interval: Interval cadangan, ditentukan dalam format durasi ISO 8601. Misalnya, PT1H mewakili satu jam dan P1D mewakili satu hari.

    I|1602673264|P1D
    Retention

    integer

    No

    Periode retensi cadangan, dalam hari. Nilai minimum adalah 1.

    7
    ClusterId

    string

    No

    ID kelompok klien yang menjalankan pekerjaan sinkronisasi data. Parameter ini hanya diperlukan jika SourceType diatur ke SYNC.

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

    string

    No

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

    005494
    CreateTime

    integer

    No

    pengatur waktu pembuatan sistem file, ditentukan sebagai stempel waktu UNIX dalam detik. Parameter ini hanya diperlukan jika SourceType diatur ke NAS.

    1607436917
    Bucket

    string

    No

    Nama bucket OSS. Parameter ini hanya diperlukan jika SourceType diatur ke OSS.

    hbr-backup-oss
    Prefix

    string

    No

    Awalan objek yang akan dicadangkan. Jika ditentukan, hanya objek dengan awalan ini yang akan dicadangkan. Parameter ini hanya diperlukan jika SourceType diatur ke OSS.

    oss-prefix
    InstanceId

    string

    No

    ID Instance ECS. Parameter ini hanya diperlukan jika SourceType diatur ke ECS_FILE.

    i-m5e*****6q
    Detail

    object

    No

    Detail cadangan seluruh Instans, ditentukan sebagai string JSON.

    • snapshotGroup: Apakah akan menggunakan kelompok konsisten snapshot. Fitur ini hanya tersedia jika semua cloud disk Instans adalah ESSD.

    • appConsistent: Apakah akan mengaktifkan konsistensi aplikasi. Ini harus digunakan bersama parameter preScriptPath dan postScriptPath.

    • preScriptPath: Jalur ke skrip pra-membekukan.

    • postScriptPath: Jalur ke skrip pasca-pencairan.

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

    string

    No

    Wilayah tempat Instance ECS berada.

    cn-shanghai
    SpeedLimit

    string

    No

    Kebijakan pembentukan trafik untuk cadangan. Format: {start}:{end}:{bandwidth}. Anda dapat menentukan beberapa aturan yang dipisahkan oleh garis vertikal (|). Rentang pengatur waktu yang ditentukan tidak boleh tumpang tindih. Parameter ini hanya diperlukan jika SourceType diatur ke ECS_FILE.

    • start: Jam mulai.

    • end: Jam selesai.

    • bandwidth: Batas bandwidth, dalam KB/s.

    0:24:5120
    Include

    string

    No

    Jalur file dan direktori yang akan disertakan dalam cadangan. Jalur dapat memiliki panjang hingga 255 karakter. Parameter ini hanya diperlukan jika SourceType diatur ke ECS_FILE.

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

    string

    No

    Jalur file dan direktori yang akan dikecualikan dari cadangan. Jalur dapat memiliki panjang hingga 255 karakter. Parameter ini hanya diperlukan jika SourceType diatur ke ECS_FILE.

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

    string

    No

    Apakah akan menggunakan Windows Volume Shadow Copy Service (VSS) untuk memastikan konsistensi data. Parameter ini hanya diperlukan jika SourceType diatur ke ECS_FILE.

    • Fitur ini hanya tersedia untuk Instance ECS Windows.

    • Jika data di sumber cadangan berubah selama pencadangan, atur parameter ini menjadi {"UseVSS":true} untuk memastikan konsistensi data.

    • Jika Anda mengaktifkan VSS, Anda tidak dapat mencadangkan beberapa direktori file pada pengatur waktu yang sama.

    {"UseVSS":false}
    DataSourceId

    string

    No

    ID sumber data asal. Parameter ini hanya diperlukan jika SourceType diatur ke SYNC.

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

    array

    No

    Jalur cadangan.

    string

    No

    A backup path. The path can be up to 65,536 characters in length. The following rules apply to backup paths:

    • If you do not use wildcards (*), you can specify up to 20 paths.

    • If you use wildcards (*), you can specify only one path. Wildcard patterns such as /*/* are supported.

    • Each path must be an absolute path.

    • If VSS is enabled, you cannot use multiple paths, UNC paths, wildcards, or file exclusions.

    • When a UNC path is used, VSS, wildcards, and file exclusions are not supported. If the backup source contains UNC paths, Windows ACLs are not backed up.

    ["/home"]
    Rule

    array<object>

    No

    Aturan cadangan.

    object

    No

    A backup rule.

    DestinationRetention

    integer

    No

    The retention period of the geo-redundant backup, in days.

    7
    Schedule

    string

    No

    The backup policy. The format is I|{startTime}|{interval}. This specifies that a backup job runs at an interval of {interval}, starting from {startTime}. Overdue backup jobs are not retried. If the previous backup job is not complete, the next backup job is not triggered. For example, I|1631685600|P1D indicates that a backup job runs daily starting from 14:00:00 on September 15, 2021.

    In the format, startTime is the backup start time (a UNIX timestamp in seconds), and interval is the backup interval (in ISO 8601 duration format). For example, PT1H represents one hour and P1D represents one day.

    I|1602673264|P1D
    Retention

    integer

    No

    The retention period of the backup, in days.

    7
    Disabled

    boolean

    No

    Specifies whether to disable the rule.

    false
    DoCopy

    boolean

    No

    Specifies whether to enable geo-redundancy for the backup.

    false
    DestinationRegionId

    string

    No

    The ID of the destination region for geo-redundancy.

    cn-hangzhou
    RuleName

    string

    No

    The name of the rule.

    rule-test-name
    BackupType

    string

    No

    The backup type.

    COMPLETE
    InstanceName

    string

    No

    Nama Instans Tablestore.

    instancename
    OtsDetail OtsDetail

    No

    Detail Instans Tablestore.

    CrossAccountType

    string

    No

    Jenis cadangan lintas akun. Nilai valid:

    • SELF_ACCOUNT: Mencadangkan data dalam akun yang sama.

    • CROSS_ACCOUNT: Mencadangkan data ke akun yang berbeda.

    Valid values:

    • SELF_ACCOUNT :

      SELF_ACCOUNT.

    • CROSS_ACCOUNT :

      CROSS_ACCOUNT.

    CROSS_ACCOUNT
    CrossAccountUserId

    integer

    No

    ID akun Alibaba Cloud sumber untuk cadangan lintas akun.

    15897534xxxx4625
    CrossAccountRoleName

    string

    No

    Nama peran RAM yang dibuat di akun sumber.

    BackupRole
    KeepLatestSnapshots

    integer

    No

    Apakah akan menyimpan snapshot cadangan terbaru secara permanen.

    • 0: Tidak menyimpan.

    • 1: Menyimpan.

    Valid values:

    • 0 :

      No

    • 1 :

      Ya.

    1
    DestSourceType

    string

    No

    Jenis sumber data tujuan. Parameter ini hanya diperlukan jika SourceType diatur ke SYNC.

    OSS
    DestDataSourceId

    string

    No

    ID sumber data tujuan. Parameter ini hanya diperlukan jika SourceType diatur ke SYNC.

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

    DestDataSourceDetail

    object

    No

    Detail sumber data tujuan. Parameter ini hanya diperlukan jika SourceType diatur ke SYNC.

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

    string

    No

    Konfigurasi daftar perubahan untuk sinkronisasi file inkremental. Parameter ini hanya diperlukan jika SourceType diatur ke SYNC.

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

    boolean

    No

    Apakah akan menonaktifkan rencana cadangan saat pembuatan.

    true
    Edition

    string

    No

    Edisi rencana cadangan. Nilai valid: BASIC dan STANDARD. Nilai default: STANDARD.

    STANDARD

    Elemen respons

    Element

    Type

    Description

    Example

    object

    The data returned.

    Code

    string

    The response code. A value of 200 indicates that the request was successful.

    200
    Message

    string

    The response message. If the request is successful, the value is successful. If the request fails, an error message is returned.

    successful
    RequestId

    string

    The request ID.

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

    string

    The backup plan ID.

    plan-*********************
    Success

    boolean

    Indicates whether the request was successful.

    • true: The request was successful.

    • false: The request failed.

    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.